com.esri.arcgis.server
Interface IServerDirectoryInfo

All Superinterfaces:

Serializable

All Known Subinterfaces:

IServerDirectoryInfo2

All Known Implementing Classes:

IServerDirectoryInfo2Proxy, IServerDirectoryInfoProxy, ServerDirectoryInfo

public interface IServerDirectoryInfo
extends Serializable

Provides access to properties of a server directory.

Superseded By

IServerDirectoryInfo2

Remarks

The ArcGIS Server manages a set of server directories. A server directory is a location on a file system that the GIS server is configured to clean up files it writes. Server dirtectories can be added, removed, and modified by users or developers who are members of the agsadmin users group, and therfore have administrator priviliges on the ArcGIS Server.

Users and developers who are not administrators also need access to the list of the GIS server's server directories and the set of their properties that are necessary for programming applications that use them as locations to write output. Users that are members of the agsusers user group, but are not members of the agsadmin user group, can get information about server directories using the GetServerDirectoryInfos method on IServerObjectManager to get the IServerDirectoryInfo interface.

IServerDirectoryInfo provides read-only access to a subset of the server directory's properties. These properties include:

Path: the physical path of the directory in disk

URL: the URL of the virtual directory corresonding to the physical directory

Description: the description of the server directory

CleaningMode: indicates whether the directory is cleaned by file age, by last accessed, or its contents are not cleaned up

MaxFileAge: inidicates the maximum age, or the maximum time since last accessed, that files can be in the server directory before they are cleaned up

The properties listed above are those necessary for developers of server applications to make use of the various GIS server's server directories.

Product Availability

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

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 output directory.
String	getURL() 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 output 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.

getURL

String getURL()
              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

Returns:

The pUrl

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.

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.

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 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.