com.esri.arcgis.server
Class IServerObjectConfigurationStatusProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.server.IServerObjectConfigurationStatusProxy

All Implemented Interfaces:

IServerObjectConfigurationStatus, Externalizable, Serializable

public class IServerObjectConfigurationStatusProxy
extends com.esri.arcgis.interop.Dispatch
implements IServerObjectConfigurationStatus, Serializable

Provides access to properties of a server object configuration's status to administrators.

Remarks

The IServerObjectConfigurationStatus interface provides access to information about a server object configurations status to administrators. In order to access this interface, you must connect to the GIS server as a user who is a member of the agsadmin user group.

The IServerObjectConfigurationStaus interface provides information as to the status of the confiruation (whether it is started, stopped, etc), and informaiton about the number of instances of the configutation that are running and the number of those instances that are in use by applications.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IServerObjectConfigurationStatusProxy()
	IServerObjectConfigurationStatusProxy(Object obj)
protected	IServerObjectConfigurationStatusProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IServerObjectConfigurationStatusProxy

public IServerObjectConfigurationStatusProxy()

IServerObjectConfigurationStatusProxy

public IServerObjectConfigurationStatusProxy(Object obj)
                                      throws IOException

Throws:

IOException

IServerObjectConfigurationStatusProxy

protected IServerObjectConfigurationStatusProxy(Object obj,
                                                String iid)
                                         throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

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.