com.esri.arcgis.server
Interface IServerStatus

All Superinterfaces:

Serializable

All Known Implementing Classes:

IServerStatusProxy

public interface IServerStatus
extends Serializable

Provides access to the properties of the status of the ArcGIS Server.

Remarks

The IServerStatus interface provides access to information concerning the state of the ArcGIS Server, its SOC machines and its server object configurations. This interface can be obtained with a Query Interface on IServerObjectAdmin.

The InstanceCount property holds the number of server object instances currently running on the entire ArcGIS Server (includes all SOC machines). This number will always contain two more configuration instances than you deploy. These two "extra" configuration instances correspond to an instance of the SDM.ServerDirectoryManager and an instance of the SrvLog.ServerLog configurations and are started and controlled by the SOM. You cannot alter these configurations. It is also important to note that these two instances do participate in the total number of instances allowed by the server configuration Capacity property. For example, if you set Capacity = 22, you will only be able to add 20 more configuration instances before the pool-shrinking algorithm engages. However, these two configurations will not be removed in a pool-shrinking operation and will stay on the machine on which they were instantiated unless that machine is removed or becomes disabled. In this case, the two instances will get redistributed to somewhere on the other SOC machines.

The InstanceInUseCount property holds the number of server object instances that are currently in use by ArcGIS Server clients. An instance is counted as "in use" until the client releases the server context.

The GetConfigurationStatus method returns an IServerObjectConfigurationStatus interface which can report the number of active and inactive instances and the enabled status of the configuration in the method argument.

Product Availability

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

Method Summary

IServerObjectConfigurationStatus	getConfigurationStatus(String name, String typeName) Gets the configuration status for the server object configuration with the specified Name and TypeName.
int	getInstanceCount(int access) The number of server object instances currently running in the ArcGIS server.
int	getInstanceInUseCount(int access) The number of currently running server object instances in use by clients of the ArcGIS server.
IServerMachineStatus	getMachineStatus(String machine) Gets the status for an ArcGIS Server host machine.
Date	getStartTime() The time that the server was started.
boolean	isEnabled() Indicates if the server is started and enabled(true) or not(false).

Method Detail

getInstanceCount

int getInstanceCount(int access)
                     throws IOException,
                            AutomationException

The number of server object instances currently running in the ArcGIS server.

Product Availability

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

Parameters:

access - A com.esri.arcgis.server.esriAccessLevel constant (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInstanceInUseCount

int getInstanceInUseCount(int access)
                          throws IOException,
                                 AutomationException

The number of currently running server object instances in use by clients of the ArcGIS server.

Product Availability

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

Parameters:

access - A com.esri.arcgis.server.esriAccessLevel constant (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationStatus

IServerObjectConfigurationStatus getConfigurationStatus(String name,
                                                        String typeName)
                                                        throws IOException,
                                                               AutomationException

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

Remarks

The GetConfigurationStatus method of the IServerStatus interface provides access to information about the enabled state and running instances of a particular server object configuration.

Product Availability

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

Parameters:

name - The name (in)

typeName - The typeName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMachineStatus

IServerMachineStatus getMachineStatus(String machine)
                                      throws IOException,
                                             AutomationException

Gets the status for an ArcGIS Server host machine.

Product Availability

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

Parameters:

machine - The machine (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTime

Date getStartTime()
                  throws IOException,
                         AutomationException

The time that the server was started.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the server is started and enabled(true) or not(false).

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.