IServerDirectory Interface

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

Members

Name Description
Read/write property CleaningMode The mode by which the files in the server directory are cleaned (by age, by size or none).
Read/write property Description The description of the server directory.
Read/write property MaxFileAge 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.
Read/write property Path The path of the server directory.
Read/write property URL The URL of the virtual directory that maps to the physical directory as described by the Path property.

IServerDirectory.CleaningMode Property

The mode by which the files in the server directory are cleaned (by age, by size or none).

Public Property CleaningMode As esriServerDirectoryCleaningMode
public esriServerDirectoryCleaningMode CleaningMode {get; set;}

IServerDirectory.Description Property

The description of the server directory.

Public Property Description As String
public string Description {get; set;}

IServerDirectory.MaxFileAge Property

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.

Public Property MaxFileAge As Integer
public int MaxFileAge {get; set;}

Remarks

MaxFileAge is specified in seconds.

IServerDirectory.Path Property

The path of the server directory.

Public Property Path As String
public string Path {get; set;}

IServerDirectory.URL Property

The URL of the virtual directory that maps to the physical directory as described by the Path property.

Public Property URL As String
public string URL {get; set;}

Remarks

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

Classes that implement IServerDirectory

Classes Description
ServerDirectory The ServerDirectory object which provides information about the ServerDirectory.

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.