com.esri.arcgis.server
Class IServerDirectoryProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.server.IServerDirectoryProxy

All Implemented Interfaces:

IServerDirectory, Externalizable, Serializable

Direct Known Subclasses:

IServerDirectory2Proxy

public class IServerDirectoryProxy
extends com.esri.arcgis.interop.Dispatch
implements IServerDirectory, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IServerDirectoryProxy()
	IServerDirectoryProxy(Object obj)
protected	IServerDirectoryProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IServerDirectoryProxy

public IServerDirectoryProxy()

IServerDirectoryProxy

public IServerDirectoryProxy(Object obj)
                      throws IOException

Throws:

IOException

IServerDirectoryProxy

protected IServerDirectoryProxy(Object obj,
                                String iid)
                         throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getPath

public 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

Specified by:

getPath in interface IServerDirectory

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPath

public 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

Specified by:

setPath in interface IServerDirectory

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURL

public 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

Specified by:

getURL in interface IServerDirectory

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURL

public 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

Specified by:

setURL in interface IServerDirectory

Parameters:

pUrl - The pUrl (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public 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

Specified by:

getDescription in interface IServerDirectory

Returns:

The pText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public 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

Specified by:

setDescription in interface IServerDirectory

Parameters:

pText - The pText (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCleaningMode

public 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

Specified by:

getCleaningMode in interface IServerDirectory

Returns:

A com.esri.arcgis.server.esriServerDirectoryCleaningMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCleaningMode

public 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

Specified by:

setCleaningMode in interface IServerDirectory

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

public 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

Specified by:

getMaxFileAge in interface IServerDirectory

Returns:

The pAge

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxFileAge

public 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

Specified by:

setMaxFileAge in interface IServerDirectory

Parameters:

pAge - The pAge (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.