com.esri.arcgis.server
Class ServerObjectManager

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

All Implemented Interfaces:

IServerObjectManager, IServerObjectManager2, java.io.Serializable

public class ServerObjectManager

extends java.lang.Object

implements IServerObjectManager, IServerObjectManager2

The ServerObjectManager object which creates ServerContext, ServerObjectConfigurationInfo and ServerObjectTypeInfo objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

The ServerObjectManager object provides access to information about the GIS server to non-administrators, and creates ServerContexts for use by applications. Any application that runs as a user account in the agsusers user group on the ArcGIS Server can use the IGISServerConnection interface to connect to the ArcGIS Server and to get a reference to the ServerObjectManager.

A ServerContext is a reserved space within the server dedicated to a set of running objects. GIS server objects also live in a server context. When developing applications with ArcGIS server, all ArcObjects that your application creates and uses live within a server context.

See Also:

IServerObjectManager, ServerContext, ServerObjectAdmin, Serialized Form

Constructor Summary

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

Method Summary

IServerContext	createServerContext(java.lang.String configName, java.lang.String typeName) Gets a reference to a server context.
boolean	equals(java.lang.Object o) Compare this object with another
IServerObjectManager	getAsIServerObjectManager() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IServerObjectManager2	getAsIServerObjectManager2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IServerObjectConfigurationInfo	getConfigurationInfo(java.lang.String name, java.lang.String typeName) Gets the ServerObjectConfigurationInfo for the specified Name and TypeName.
IEnumServerObjectConfigurationInfo	getConfigurationInfos() An enumerator over all the GIS server's ServerObjectConfigurationInfos.
IEnumServerObjectConfigurationInfo	getConfigurationInfosEx(java.lang.String folderName) An enumerator over all the ArcGIS server's ServerObjectExtensionInfos in a given folder.
IServerObjectConfigurationStatus	getConfigurationStatus(java.lang.String name, java.lang.String typeName) Get the configuration status for a server object configuration with the specified Name and TypeName.
IEnumServerObjectExtensionTypeInfo	getExtensionTypeInfos(java.lang.String sOTypeName) An enumerator over all the ArcGIS server's ServerObjectExtensionTypeInfos.
IPropertySet	getFolderInfo(java.lang.String folderName) Properties associated with a server configuration folder.
IEnumBSTR	getFolders(java.lang.String folderName) An array of folder names in the server configuration folder.
IEnumServerDirectoryInfo	getServerDirectoryInfos() An enumerator over all the GIS server's ServerDirectoryInfos.
IPropertySet	getSystemInfo() The properties of the underlying system hardware and software.
IEnumServerObjectTypeInfo	getTypeInfos() An enumerator over all the GIS server's ServerObjectTypeInfos.
int	hashCode() the hashcode for this object

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerObjectManager

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

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

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

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIServerObjectManager

public IServerObjectManager getAsIServerObjectManager()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIServerObjectManager2

public IServerObjectManager2 getAsIServerObjectManager2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

createServerContext

public IServerContext createServerContext(java.lang.String configName,
                                          java.lang.String typeName)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IServerObjectManager

Gets a reference to a server context. The server context can be based on a specified server object configuration, or can be an empty server context if not server object configuration is specified.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CreateServerContext method on IServerObjectManager is used to get a reference to a context on the server. A context is a process managed by the server within which a server object runs. You can use CreateServerContext to create a context based on a server object configuration, or you can create empty contexts soley for the purpose of creating ArcObjects on the fly within the server.

When using CreateServerContext to create a context based on a server object configuration, if the server object configuration is pooled, you may get a reference to a context that is already created and running in the server. When you have completed using that context, it is important to released it explicitly by calling the ReleaseContext method on IServerContext to return it to the pool. When using CreateServerContext to create a context based on a non-pooled server object configuration, or when creating an empty context, a new context is created on the server. You still need to call ReleaseContext when you are finished using it, and the context is destroyed on the server.

As of 9.2 some of the possible values for typeName are:

• MapServer - to get a Map Server context
• GeocodeServer - to get a Geocode Server context

Specified by:

createServerContext in interface IServerObjectManager

Parameters:

configName - The configName (in)

typeName - The typeName (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getConfigurationInfo

public IServerObjectConfigurationInfo getConfigurationInfo(java.lang.String name,
                                                           java.lang.String typeName)
                                                    throws java.io.IOException,
                                                           AutomationException

Description copied from interface: IServerObjectManager

Gets the ServerObjectConfigurationInfo for the specified Name and TypeName.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns the server configuration with the specified Name and Type as an ServerObjectConfigurationInfo object. The Info object provides information about the server object configuration required to make use of them in an application. This method will only return a ServerObjectConfigurationInfo for configurations which are started. If you call this method and specify a configuration which is not started, it will return an error.

Additional information about started server object configurations, and configurations that are not started can be accessed using the IServerObjectAdmin interface.

Specified by:

getConfigurationInfo in interface IServerObjectManager

Parameters:

name - The name (in)

typeName - The typeName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationInfos

public IEnumServerObjectConfigurationInfo getConfigurationInfos()
                                                         throws java.io.IOException,
                                                                AutomationException

Description copied from interface: IServerObjectManager

An enumerator over all the GIS server's ServerObjectConfigurationInfos.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns and enumeration of the started server object configurations configured in the server as ServerObjectConfigurationInfo objects. These Info objects provide information about the server object configurations and types required to make use of them in an application.

Additional information about started server object configurations, and configurations that are not started can be accessed using the IServerObjectAdmin interface.

Specified by:

getConfigurationInfos in interface IServerObjectManager

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTypeInfos

public IEnumServerObjectTypeInfo getTypeInfos()
                                       throws java.io.IOException,
                                              AutomationException

Description copied from interface: IServerObjectManager

An enumerator over all the GIS server's ServerObjectTypeInfos.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns and enumeration of server object types in the server as ServerObjectTypeInfo objects. These Info objects provide information about the server object types required to make use of them in an application. Additional information about server object types in the server can be accessed using the IServerObjectAdmin interface.

Specified by:

getTypeInfos in interface IServerObjectManager

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerDirectoryInfos

public IEnumServerDirectoryInfo getServerDirectoryInfos()
                                                 throws java.io.IOException,
                                                        AutomationException

Description copied from interface: IServerObjectManager

An enumerator over all the GIS server's ServerDirectoryInfos.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns an enumeration of server directories configured in the server as ServerDirectoryInfo objects. These Info objects provide information about the server directories required to make use of them in an application. Additional information about server directories configured in the server can be accessed using the IServerObjectAdmin interface.

Specified by:

getServerDirectoryInfos in interface IServerObjectManager

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSystemInfo

public IPropertySet getSystemInfo()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IServerObjectManager2

The properties of the underlying system hardware and software.

Description

The SystemInfo property returns a PropertySet containing properties indicating the operating system name and messaeg version of the GIS server.

Specified by:

getSystemInfo in interface IServerObjectManager2

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionTypeInfos

public IEnumServerObjectExtensionTypeInfo getExtensionTypeInfos(java.lang.String sOTypeName)
                                                         throws java.io.IOException,
                                                                AutomationException

Description copied from interface: IServerObjectManager2

An enumerator over all the ArcGIS server's ServerObjectExtensionTypeInfos.

Remarks

Retrieves an enumeration of IServerObjectTypeInfos from the ArcGIS Server system configuration (Server.cfg). The IServerObjectTypeInfo interface provides the name and description of a server object type.

Specified by:

getExtensionTypeInfos in interface IServerObjectManager2

Parameters:

sOTypeName - The sOTypeName (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getConfigurationInfosEx

public IEnumServerObjectConfigurationInfo getConfigurationInfosEx(java.lang.String folderName)
                                                           throws java.io.IOException,
                                                                  AutomationException

Description copied from interface: IServerObjectManager2

An enumerator over all the ArcGIS server's ServerObjectExtensionInfos in a given folder.

Specified by:

getConfigurationInfosEx in interface IServerObjectManager2

Parameters:

folderName - The folderName (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFolders

public IEnumBSTR getFolders(java.lang.String folderName)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IServerObjectManager2

An array of folder names in the server configuration folder.

Specified by:

getFolders in interface IServerObjectManager2

Parameters:

folderName - The folderName (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFolderInfo

public IPropertySet getFolderInfo(java.lang.String folderName)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IServerObjectManager2

Properties associated with a server configuration folder.

Specified by:

getFolderInfo in interface IServerObjectManager2

Parameters:

folderName - The folderName (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getConfigurationStatus

public IServerObjectConfigurationStatus getConfigurationStatus(java.lang.String name,
                                                               java.lang.String typeName)
                                                        throws java.io.IOException,
                                                               AutomationException

Description copied from interface: IServerObjectManager2

Get the configuration status for a server object configuration with the specified Name and TypeName.

Specified by:

getConfigurationStatus in interface IServerObjectManager2

Parameters:

name - The name (in)

typeName - The typeName (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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