com.esri.arcgis.server
Interface IServerObjectConfiguration5

All Superinterfaces:

IServerObjectConfiguration, IServerObjectConfiguration2, IServerObjectConfiguration3, IServerObjectConfiguration4, Serializable

public interface IServerObjectConfiguration5
extends IServerObjectConfiguration4, Serializable

Provides access to administrators to members that control the behavior and properties of a server object configuration with extensions.

Product Availability

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

Method Summary

IStringArray	getDatasetNames() The dataset names associated with configuration.
IStringArray	getExtensionNames() The extension names of this server object configuration.
int	getLoadBalancing() The service load balancing type.
int	getStatus() Status of the server object configuration.
String	getTargetCluster() The target cluster for this service to be published to.
void	setDatasetNames(IStringArray ppDTNames) The dataset names associated with configuration.
void	setLoadBalancing(int pType) The service load balancing type.
void	setStatus(int pStatus) Status of the server object configuration.
void	setTargetCluster(String pName) The target cluster for this service to be published to.

Methods inherited from interface com.esri.arcgis.server.IServerObjectConfiguration4

getServiceKeepAliveInterval, setServiceKeepAliveInterval

Methods inherited from interface com.esri.arcgis.server.IServerObjectConfiguration3

getIdleTimeout, getInstancesPerContainer, setIdleTimeout, setInstancesPerContainer

Methods inherited from interface com.esri.arcgis.server.IServerObjectConfiguration2

deserialize, getCleanupTimeout, getExtensionInfo, getExtensionProperties, getInfo, getStartupTimeout, isExtensionEnabled, serialize, setCleanupTimeout, setExtensionEnabled, setExtensionInfoByRef, setExtensionPropertiesByRef, setInfoByRef, setStartupTimeout

Methods inherited from interface com.esri.arcgis.server.IServerObjectConfiguration

getDescription, getIsolationLevel, getMaxInstances, getMinInstances, getName, getProperties, getRecycleProperties, getStartupType, getTypeName, getUsageTimeout, getWaitTimeout, isPooled, setDescription, setIsolationLevel, setIsPooled, setMaxInstances, setMinInstances, setName, setPropertiesByRef, setRecyclePropertiesByRef, setStartupType, setTypeName, setUsageTimeout, setWaitTimeout

Method Detail

setStatus

void setStatus(int pStatus)
               throws IOException,
                      AutomationException

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

Product Availability

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

Parameters:

pStatus - A com.esri.arcgis.server.esriConfigurationStatus constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

int getStatus()
              throws IOException,
                     AutomationException

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

Product Availability

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

Returns:

A com.esri.arcgis.server.esriConfigurationStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionNames

IStringArray getExtensionNames()
                               throws IOException,
                                      AutomationException

The extension names of this server object configuration.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetNames

void setDatasetNames(IStringArray ppDTNames)
                     throws IOException,
                            AutomationException

The dataset names associated with configuration.

Product Availability

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

Parameters:

ppDTNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

IStringArray getDatasetNames()
                             throws IOException,
                                    AutomationException

The dataset names associated with configuration.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetCluster

void setTargetCluster(String pName)
                      throws IOException,
                             AutomationException

The target cluster for this service to be published to.

Product Availability

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

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetCluster

String getTargetCluster()
                        throws IOException,
                               AutomationException

The target cluster for this service to be published to.

Product Availability

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

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLoadBalancing

void setLoadBalancing(int pType)
                      throws IOException,
                             AutomationException

The service load balancing type.

Product Availability

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

Parameters:

pType - A com.esri.arcgis.server.esriLoadBalancing constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLoadBalancing

int getLoadBalancing()
                     throws IOException,
                            AutomationException

The service load balancing type.

Product Availability

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

Returns:

A com.esri.arcgis.server.esriLoadBalancing constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.