com.esri.arcgis.server
Class ServerObjectFactoryX

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerObjectFactoryX, ISupportErrorInfo, Serializable

public class ServerObjectFactoryX
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IServerObjectFactoryX

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ServerObjectFactoryX()
Constructs a ServerObjectFactoryX using ArcGIS Engine.

ServerObjectFactoryX(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ServerObjectFactoryX theServerObjectFactoryX = (ServerObjectFactoryX) obj;

Method Summary

void	addAddInFolder(String addInFolderPath) Adds a folder to the Add In folder processing list.
IConfigurationFactory	createConfigurationFactory(String cfgName, String cfgType, String cLSID) Creates a new server configuration factory for a given type.
Object	createObject(String cLSID) Creates an instance of an AddIn given a CLSID.
IServerObject	createServerObject(String cLSID, String cfgName, String cfgType, IPropertySet ipProps) Creates a new server object given a CLSID.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getJobRegistryPath() Gets the path to the job registry that was set on the factory.
String	getLogDirectoryPath() Gets the path to the log directory that was set on the factory.
String	getLogLevel() Gets the log level that was set on the factory.
int	getMaxLogFileSize() Gets the maximum size of the log file that was set on the factory.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	removeAddInFolder(String addInFolderPath) Removes a folder from the Add In folder processing list.
void	setJobRegistryPath(String jobRegPath) Sets the path to the job registry maintained on disk.
void	setLogDirectoryPath(String logDirPath) Sets the path to the log directory.
void	setLogLevel(String logLevel) Sets the log level.
void	setMaxLogFileSize(int maxLogFileSize) Sets the maximum size of the log file.
void	setProcessId(int processId) Sets the process id.
void	setProductCode(int productCode) Sets the product code.
void	shutdown() Cleanup routine that indicates a shutdown of the STA thread thats hosting factory.
void	shutdownEx(IServerObject ipSO) Cleanup routine that calls ShutDown on the Server object and extensions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ServerObjectFactoryX

public ServerObjectFactoryX()
                     throws IOException,
                            UnknownHostException

Constructs a ServerObjectFactoryX using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ServerObjectFactoryX

public ServerObjectFactoryX(Object obj)
                     throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ServerObjectFactoryX theServerObjectFactoryX = (ServerObjectFactoryX) obj;

Construct a ServerObjectFactoryX using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ServerObjectFactoryX.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addAddInFolder

public void addAddInFolder(String addInFolderPath)
                    throws IOException,
                           AutomationException

Adds a folder to the Add In folder processing list.

Product Availability

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

Specified by:

addAddInFolder in interface IServerObjectFactoryX

Parameters:

addInFolderPath - The addInFolderPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAddInFolder

public void removeAddInFolder(String addInFolderPath)
                       throws IOException,
                              AutomationException

Removes a folder from the Add In folder processing list.

Product Availability

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

Specified by:

removeAddInFolder in interface IServerObjectFactoryX

Parameters:

addInFolderPath - The addInFolderPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProductCode

public void setProductCode(int productCode)
                    throws IOException,
                           AutomationException

Sets the product code.

Product Availability

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

Specified by:

setProductCode in interface IServerObjectFactoryX

Parameters:

productCode - The productCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJobRegistryPath

public void setJobRegistryPath(String jobRegPath)
                        throws IOException,
                               AutomationException

Sets the path to the job registry maintained on disk.

Product Availability

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

Specified by:

setJobRegistryPath in interface IServerObjectFactoryX

Parameters:

jobRegPath - The jobRegPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobRegistryPath

public String getJobRegistryPath()
                          throws IOException,
                                 AutomationException

Gets the path to the job registry that was set on the factory.

Product Availability

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

Specified by:

getJobRegistryPath in interface IServerObjectFactoryX

Returns:

The pJobRegPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogDirectoryPath

public void setLogDirectoryPath(String logDirPath)
                         throws IOException,
                                AutomationException

Sets the path to the log directory.

Product Availability

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

Specified by:

setLogDirectoryPath in interface IServerObjectFactoryX

Parameters:

logDirPath - The logDirPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLogDirectoryPath

public String getLogDirectoryPath()
                           throws IOException,
                                  AutomationException

Gets the path to the log directory that was set on the factory.

Product Availability

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

Specified by:

getLogDirectoryPath in interface IServerObjectFactoryX

Returns:

The pLogDirPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogLevel

public void setLogLevel(String logLevel)
                 throws IOException,
                        AutomationException

Sets the log level.

Product Availability

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

Specified by:

setLogLevel in interface IServerObjectFactoryX

Parameters:

logLevel - The logLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLogLevel

public String getLogLevel()
                   throws IOException,
                          AutomationException

Gets the log level that was set on the factory.

Product Availability

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

Specified by:

getLogLevel in interface IServerObjectFactoryX

Returns:

The pLogLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxLogFileSize

public void setMaxLogFileSize(int maxLogFileSize)
                       throws IOException,
                              AutomationException

Sets the maximum size of the log file.

Product Availability

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

Specified by:

setMaxLogFileSize in interface IServerObjectFactoryX

Parameters:

maxLogFileSize - The maxLogFileSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxLogFileSize

public int getMaxLogFileSize()
                      throws IOException,
                             AutomationException

Gets the maximum size of the log file that was set on the factory.

Product Availability

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

Specified by:

getMaxLogFileSize in interface IServerObjectFactoryX

Returns:

The pMaxLogFileSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createServerObject

public IServerObject createServerObject(String cLSID,
                                        String cfgName,
                                        String cfgType,
                                        IPropertySet ipProps)
                                 throws IOException,
                                        AutomationException

Creates a new server object given a CLSID.

Product Availability

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

Specified by:

createServerObject in interface IServerObjectFactoryX

Parameters:

cLSID - The cLSID (in)

cfgName - The cfgName (in)

cfgType - The cfgType (in)

ipProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createConfigurationFactory

public IConfigurationFactory createConfigurationFactory(String cfgName,
                                                        String cfgType,
                                                        String cLSID)
                                                 throws IOException,
                                                        AutomationException

Creates a new server configuration factory for a given type.

Product Availability

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

Specified by:

createConfigurationFactory in interface IServerObjectFactoryX

Parameters:

cfgName - The cfgName (in)

cfgType - The cfgType (in)

cLSID - The cLSID (in)

Returns:

A reference to a com.esri.arcgis.server.IConfigurationFactory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createObject

public Object createObject(String cLSID)
                    throws IOException,
                           AutomationException

Creates an instance of an AddIn given a CLSID.

Product Availability

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

Specified by:

createObject in interface IServerObjectFactoryX

Parameters:

cLSID - The cLSID (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException

Cleanup routine that indicates a shutdown of the STA thread thats hosting factory.

Product Availability

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

Specified by:

shutdown in interface IServerObjectFactoryX

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdownEx

public void shutdownEx(IServerObject ipSO)
                throws IOException,
                       AutomationException

Cleanup routine that calls ShutDown on the Server object and extensions.

Product Availability

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

Specified by:

shutdownEx in interface IServerObjectFactoryX

Parameters:

ipSO - A reference to a com.esri.arcgis.server.IServerObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessId

public void setProcessId(int processId)
                  throws IOException,
                         AutomationException

Sets the process id.

Product Availability

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

Specified by:

setProcessId in interface IServerObjectFactoryX

Parameters:

processId - The processId (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.