com.esri.arcgis.server
Interface IServerDirectory

All Superinterfaces:
Serializable
All Known Subinterfaces:
IServerDirectory2
All Known Implementing Classes:
IServerDirectory2Proxy, IServerDirectoryProxy, ServerDirectory

public interface IServerDirectory
extends Serializable

Provides access to members that control the behavior and properties of a server directory to administrators.

Superseded By

IServerDirectory2

Remarks

A server directory is a location on a file system that the GIS server is configured to clean up files it writes. By definitition, a server directory can be written to by all container machines. Files in a server directory can be cleaned based on file age, or based on when the file was last accessed. The maximum file age or tim esince last accessed is a property of a server directory. If the ClenaingMode is esriDCAbsolute, then all files created by the GIS server that are older than the maximum age are automatically cleaned up by the GIS server. If the ClenaingMode is esriDCSliding, then all files created by the GIS server that have not been access for a duration defined by maximum age are automatically cleaned up by the GIS server.

Note that when creating files in a server directory, they must be prefixed with "_ags_" in order to be cleaned up by the GIS server. Any files in a server directory not prefixed with "_ags_" will not be cleaned up.

The IServerDirectory interface allows you to configure the properties of a server directory to add it to the GIS Server. You must set the Path, CleaningMode, MaxFileAge (if cleaning mode is absolute or sliding) properties for the server directory which will be the directories path on disk. The Description and URL are optional.

The URL property is the virtual directory that corresponds to the physical directory specified by the Name property. Server objects (such as a map server object) can use the Name property to write their output files to a directory where they will be cleaned up, and can pass back to clients the URL for the locaiton of the files they write. Clients (for example web applications) will then not require direct access to the physical directory.

Use the AddServerDirectory method on IServerObjectAdmin to add the new server directory to your GIS Server.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getCleaningMode()
          The mode by which the files in the server directory are cleaned (by age, by size or none).
 String getDescription()
          The description of the server directory.
 int getMaxFileAge()
          The maximum age (in seconds) a file can be in the server directory before it is deleted, if the cleaning mode is by file age.
 String getPath()
          The path of the server directory.
 String getURL()
          The URL of the virtual directory that maps to the physical directory as described by the Path property.
 void setCleaningMode(int pMode)
          The mode by which the files in the server directory are cleaned (by age, by size or none).
 void setDescription(String pText)
          The description of the server directory.
 void setMaxFileAge(int pAge)
          The maximum age (in seconds) a file can be in the server directory before it is deleted, if the cleaning mode is by file age.
 void setPath(String pPath)
          The path of the server directory.
 void setURL(String pUrl)
          The URL of the virtual directory that maps to the physical directory as described by the Path property.
 

Method Detail

getPath

String getPath()
               throws IOException,
                      AutomationException
The path of the server directory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPath

void setPath(String pPath)
             throws IOException,
                    AutomationException
The path of the server directory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pPath - The pPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getURL

String getURL()
              throws IOException,
                     AutomationException
The URL of the virtual directory that maps to the physical directory as described by the Path property.

Remarks

The URL is a virtual directory for the pysical directory specified by the Name property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pUrl
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setURL

void setURL(String pUrl)
            throws IOException,
                   AutomationException
The URL of the virtual directory that maps to the physical directory as described by the Path property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pUrl - The pUrl (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
The description of the server directory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pText
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String pText)
                    throws IOException,
                           AutomationException
The description of the server directory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pText - The pText (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCleaningMode

int getCleaningMode()
                    throws IOException,
                           AutomationException
The mode by which the files in the server directory are cleaned (by age, by size or none).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.server.esriServerDirectoryCleaningMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCleaningMode

void setCleaningMode(int pMode)
                     throws IOException,
                            AutomationException
The mode by which the files in the server directory are cleaned (by age, by size or none).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pMode - A com.esri.arcgis.server.esriServerDirectoryCleaningMode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxFileAge

int getMaxFileAge()
                  throws IOException,
                         AutomationException
The maximum age (in seconds) a file can be in the server directory before it is deleted, if the cleaning mode is by file age.

Remarks

MaxFileAge is specified in seconds.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pAge
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxFileAge

void setMaxFileAge(int pAge)
                   throws IOException,
                          AutomationException
The maximum age (in seconds) a file can be in the server directory before it is deleted, if the cleaning mode is by file age.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pAge - The pAge (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.