com.esri.arcgis.server
Class ServerDirectory

java.lang.Object
  com.esri.arcgis.server.ServerDirectory

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerDirectory, IServerDirectory2, java.io.Serializable

public class ServerDirectory
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerDirectory, IServerDirectory2

COM Class 'ServerDirectory'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriServer.olb'

Description 'The ServerDirectory object which provides information about the ServerDirectory.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.server.IServerDirectory2

IID, IIDf284d482_f71b_4542_9c93_1dc4b7e79881, xxDummy

Fields inherited from interface com.esri.arcgis.server.IServerDirectory

IIDe7402a4c_0962_4e2e_ba8f_e90b6dabfcb2

Constructor Summary

ServerDirectory(java.lang.Object obj)
Construct a ServerDirectory using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
int	getCleaningMode() The mode by which the files in the server directory are cleaned (by age, by size or none).
java.lang.String	getDescription() The description of the server directory.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
java.lang.String	getPath() The path of the server directory.
int	getType() The Type of server directory.
java.lang.String	getURL() The URL of the virtual directory that maps to the physical directory as described by the Path property.
int	hashCode() the hashcode for this object
void	release() Release a ServerDirectory.
void	setCleaningMode(int pMode) The mode by which the files in the server directory are cleaned (by age, by size or none).
void	setDescription(java.lang.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(java.lang.String pPath) The path of the server directory.
void	setType(int pType) The Type of server directory.
void	setURL(java.lang.String pUrl) The URL of the virtual directory that maps to the physical directory as described by the Path property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerDirectory

public ServerDirectory(java.lang.Object obj)
                throws java.io.IOException

Construct a ServerDirectory using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ServerDirectory.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ServerDirectory o = (ServerDirectory)obj; // will not work

ServerDirectory o = new ServerDirectory(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems ServerDirectory theServerDirectory = (ServerDirectory) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ServerDirectory.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getPath

public java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException

The path of the server directory.

Specified by:

getPath in interface IServerDirectory

Returns:

The pPath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(java.lang.String pPath)
             throws java.io.IOException,
                    AutomationException

The path of the server directory.

Specified by:

setPath in interface IServerDirectory

Parameters:

pPath - The pPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURL

public java.lang.String getURL()
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

getURL in interface IServerDirectory

Returns:

The pUrl

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURL

public void setURL(java.lang.String pUrl)
            throws java.io.IOException,
                   AutomationException

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

Specified by:

setURL in interface IServerDirectory

Parameters:

pUrl - The pUrl (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The description of the server directory.

Specified by:

getDescription in interface IServerDirectory

Returns:

The pText

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String pText)
                    throws java.io.IOException,
                           AutomationException

The description of the server directory.

Specified by:

setDescription in interface IServerDirectory

Parameters:

pText - The pText (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCleaningMode

public int getCleaningMode()
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

getCleaningMode in interface IServerDirectory

Returns:

A com.esri.arcgis.server.esriServerDirectoryCleaningMode constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCleaningMode

public void setCleaningMode(int pMode)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setCleaningMode in interface IServerDirectory

Parameters:

pMode - A com.esri.arcgis.server.esriServerDirectoryCleaningMode constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxFileAge

public int getMaxFileAge()
                  throws java.io.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.

Specified by:

getMaxFileAge in interface IServerDirectory

Returns:

The pAge

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxFileAge

public void setMaxFileAge(int pAge)
                   throws java.io.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.

Specified by:

setMaxFileAge in interface IServerDirectory

Parameters:

pAge - The pAge (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The Type of server directory.

Specified by:

getType in interface IServerDirectory2

Returns:

A com.esri.arcgis.server.esriServerDirectoryType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int pType)
             throws java.io.IOException,
                    AutomationException

The Type of server directory.

Specified by:

setType in interface IServerDirectory2

Parameters:

pType - A com.esri.arcgis.server.esriServerDirectoryType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.