com.esri.arcgis.server
Class ServerObjectConfigurationInfo

java.lang.Object
  extended by com.esri.arcgis.server.ServerObjectConfigurationInfo
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IServerObjectConfigurationInfo, IServerObjectConfigurationInfo2, Serializable

public class ServerObjectConfigurationInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectConfigurationInfo, IServerObjectConfigurationInfo2

The ServerObjectConfigurationInfo object which provides information about server object configurations to users without administrative privileges to the GIS server.

Remarks

The ArcGIS Server manages a set of server objects running across one or more host (container) machines. How those server objects are configured and run is defined by a set of ServerObjectConfigurations. ServerObjectConfigurations can be added, removed and modified by users or developers who are members of the agsadmin users group, and therfore have administrator priviliges on the ArcGIS Server.

Users and developers who are not administrators also need access to the list of ServerObjectConfigurations and the set of their properties that are necessary for programming applications with them. Users that are members of the agsusers user group, but are not members of the agsadmin user group can get information about server object configurations using via the ServerObjectConfigurationInfo object.

The ServerObjectConfigurationInfo object provides read only access to a subset of the server object configuration's properties. These properties include:

Name: the name of the server object configuration

TypeName: the type of server object configuration (for example MapServer, GeocodeServer)

Description: the description of the server object configuration

IsPooled: inidicates whether the server objects described by this configuration are pooled or non-pooled

Extensions: a list of the server object extensions enabled for the configuration

The properties listed above are those necessary for developers of server applications to make use of the various server objects configured on the GIS server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ServerObjectManager, ServerObjectType, IAGSServerConnectionAdmin, AGSServerConnectionName, IEnumServerObjectType, IEnumServerDirectory, AGSServerConnection, IServerConnection, ServerObjectTypeInfo, IEnumServerObjectTypeInfo, IAGSServerObject, ServerDirectoryInfo, ServerObjectConfiguration, ServerContext, ServerObjectConfigurationStatus, IAGSServerObjectName, ServerConnection, IAGSServerConnectionName, IAGSEnumServerObjectName, ServerObject, IServerObjectConfigurationInfo, IServerObjectAdmin, AGSServerConnectionFactory, IAGSServerConnectionFactory, IEnumServerObjectConfigurationInfo, IGISServerConnection, IAGSServerConnection, IServerContext, ServerDirectory, ServerObjectConfigurationInfo, IEnumServerMachine, ServerMachine, IServerObjectConfiguration, IServerObjectManager, IServerObjectTypeInfo, IServerMachine, IServerObject, IServerObjectType, GISServerConnection, AGSServerObjectName, ServerObjectAdmin, IEnumServerObjectConfiguration, Serialized Form

Constructor Summary
ServerObjectConfigurationInfo(Object obj)
          Construct a ServerObjectConfigurationInfo using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getDescription()
          Description of the server object configuration.
 IPropertySet getExtensionInfo(String name)
          The extension-dependent info for the server object configuration.
 IEnumBSTR getExtensions()
          An array of the registered server object extensions for a given configuration.
 IPropertySet getInfo()
          Auxiliary Information for the server objects created by the server object configuration passive properties only.
 String getName()
          Name of the server object configuration.
 String getTypeName()
          Type of the server object configuration (MapServer or GeocodeServer).
 int hashCode()
          the hashcode for this object
 boolean isPooled()
          Indicates whether the server objects defined by this configuration are pooled.
 
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

ServerObjectConfigurationInfo

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

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

Throws:
IOException - if there are interop problems ServerObjectConfigurationInfo theServerObjectConfigurationInfo = (ServerObjectConfigurationInfo) obj;
Method Detail

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

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the server object configuration.

Remarks

The Name property in combination with the TypeName property is used to identify a server object configuration in methods such as CreateServerContext.

Name is case-sensitive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IServerObjectConfigurationInfo
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTypeName

public String getTypeName()
                   throws IOException,
                          AutomationException
Type of the server object configuration (MapServer or GeocodeServer).

Remarks

The TypeName property indicates the type of server object that this configuration creates and runs. Examples are MapServer and GeocodeServer.

The TypeName property in combination with the Name property is used to identify a server object configuration in methods such as CreateServerContext.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTypeName in interface IServerObjectConfigurationInfo
Returns:
The typeName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
Description of the server object configuration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDescription in interface IServerObjectConfigurationInfo
Returns:
The desc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPooled

public boolean isPooled()
                 throws IOException,
                        AutomationException
Indicates whether the server objects defined by this configuration are pooled.

Remarks

Server objects can be either pooled or non-pooled. Pooled server objects can be shared accross multiple sessions and applications and are held onto by an application for the duration of a single request. Pooled server objects are meant for applications that make stateless use of those objects.

Non-pooled server objects are dedicated to a single application session and are held onto for the duration of an application session. Non-pooled server objects are not shared between application session, and are meant for applications that make stateful use of those objects.

The IsPooled property indicates if the server objects created by this server object configuration are pooled or non-pooled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isPooled in interface IServerObjectConfigurationInfo
Returns:
The isPooled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensions

public IEnumBSTR getExtensions()
                        throws IOException,
                               AutomationException
An array of the registered server object extensions for a given configuration.

Product Availability

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

Specified by:
getExtensions in interface IServerObjectConfigurationInfo2
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInfo

public IPropertySet getInfo()
                     throws IOException,
                            AutomationException
Auxiliary Information for the server objects created by the server object configuration passive properties only.

Product Availability

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

Specified by:
getInfo in interface IServerObjectConfigurationInfo2
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionInfo

public IPropertySet getExtensionInfo(String name)
                              throws IOException,
                                     AutomationException
The extension-dependent info for the server object configuration.

Product Availability

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

Specified by:
getExtensionInfo in interface IServerObjectConfigurationInfo2
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.