com.esri.arcgis.server
Interface IServerObjectFactoryX

All Superinterfaces:

Serializable

All Known Implementing Classes:

ServerObjectFactoryX

public interface IServerObjectFactoryX
extends Serializable

Factory interface to create server objects.

Product Availability

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

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

Method Detail

addAddInFolder

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.

Parameters:

addInFolderPath - The addInFolderPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAddInFolder

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.

Parameters:

addInFolderPath - The addInFolderPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProductCode

void setProductCode(int productCode)
                    throws IOException,
                           AutomationException

Sets the product code.

Product Availability

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

Parameters:

productCode - The productCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJobRegistryPath

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.

Parameters:

jobRegPath - The jobRegPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobRegistryPath

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.

Returns:

The pJobRegPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogDirectoryPath

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.

Parameters:

logDirPath - The logDirPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLogDirectoryPath

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.

Returns:

The pLogDirPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogLevel

void setLogLevel(String logLevel)
                 throws IOException,
                        AutomationException

Sets the log level.

Product Availability

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

Parameters:

logLevel - The logLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLogLevel

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.

Returns:

The pLogLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxLogFileSize

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.

Parameters:

maxLogFileSize - The maxLogFileSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxLogFileSize

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.

Returns:

The pMaxLogFileSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createServerObject

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.

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

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.

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

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.

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

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.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdownEx

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.

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

void setProcessId(int processId)
                  throws IOException,
                         AutomationException

Sets the process id.

Product Availability

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

Parameters:

processId - The processId (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.