com.esri.arcgis.server
Class ServerObjectConfigurationStatus

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerObjectConfigurationStatus, Serializable

public class ServerObjectConfigurationStatus
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectConfigurationStatus

The ServerObjectConfgurationStatus object which reports the status of a server object configuration.

Remarks

The ServerObjectConfigurationStatus object contains information about a server object configuration's status to administrators (whether it is started, stopped, etc), and information about the number of instances of the configuration that are running and the number of those instances that are in use by applications. In order to access this object, you must connect to the GIS server as a user who is a member of the agsadmin user group.

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

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

Method Summary

boolean	equals(Object o) Compare this object with another
int	getInstanceCount() Number of instances of server objects for a particular configuration that are currently running in the GIS server.
int	getInstanceInUseCount() Number of running instances of server objects for a particular configuration that are in currently use by clients of the GIS server.
int	getStatus() Status of the server object configuration.
int	hashCode() the hashcode for this object

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

ServerObjectConfigurationStatus

public ServerObjectConfigurationStatus(Object obj)
                                throws IOException

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

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

Throws:

IOException - if there are interop problems ServerObjectConfigurationStatus theServerObjectConfigurationStatus = (ServerObjectConfigurationStatus) 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

getInstanceCount

public int getInstanceCount()
                     throws IOException,
                            AutomationException

Number of instances of server objects for a particular configuration that are currently running in the GIS server.

Remarks

The InstanceCount is the numner of instances of server objects defined by the server object configuration that are currently running within the server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInstanceCount in interface IServerObjectConfigurationStatus

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInstanceInUseCount

public int getInstanceInUseCount()
                          throws IOException,
                                 AutomationException

Number of running instances of server objects for a particular configuration that are in currently use by clients of the GIS server.

Remarks

The InstanceInUseCount is the numbner of instances of server objects defined by the server object configuration that are currently in use by applications. For non-pooled server objects, the InstanceInUseCount will be the same as the InstanceCount.

This property is useful in monitoring server object usage to help you make decisions about increasing or decreasing the MinInstances and MaxInstances for a particular server object configuraiton.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInstanceInUseCount in interface IServerObjectConfigurationStatus

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

public int getStatus()
              throws IOException,
                     AutomationException

Status of the server object configuration. This status indicates whether the server object configuration is started, stopped, paused, etc.

Remarks

The Status property on IServerObjectConfigurationStatus indicates the current status of the server object configuration. A server object configuration can be in one of the following stagus categories:

Started (esriCSStarted)

Stopped (esriCSStopped)

Paused (esriCSPaused)

Starting (esriCSStarting)

Stopping (esriCSStopping)

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStatus in interface IServerObjectConfigurationStatus

Returns:

A com.esri.arcgis.server.esriConfigurationStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.