com.esri.arcgis.server
Interface IServerObjectConfiguration2

All Superinterfaces:
IServerObjectConfiguration, Serializable
All Known Subinterfaces:
IServerObjectConfiguration3, IServerObjectConfiguration4
All Known Implementing Classes:
IServerObjectConfiguration2Proxy, IServerObjectConfiguration3Proxy, ServerObjectConfiguration

public interface IServerObjectConfiguration2
extends IServerObjectConfiguration, Serializable

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

Remarks

IServerObjectConfiguration2 extends IServerObjectConfiguration with properties for managing the server object configuration's extensions.

Set the ExtensionEnabled property to true for the server object extensions you want to enable for this configuration. A list of the server object extensions installed on the GIS server for each server object type are available via IServerObjectManager2::GetExtensionTypeInfos.

Use the ExtensionProperties property to specify the collection of properties for a server object extension.

The Serialize and Deserialize methods allow you to save the server object configuration as a string, and restore it from a string. This can be useful when copying server object configurations between two GIS servers.

Product Availability

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


Method Summary
 void deserialize(String str)
          Deserializes the server object configuration from a string.
 int getCleanupTimeout()
          Maximum time (in seconds) that a SOC process will remain active to allow its no longer used server object threads to shut down gracefully before terminating them.
 IPropertySet getExtensionInfo(String name)
          The extension-dependent info for the server object configuration.
 IPropertySet getExtensionProperties(String name)
          The extension-dependent properties for the server object configuration.
 IPropertySet getInfo()
          Auxiliary Information for the server objects created by the server object configuration – passive properties only.
 int getStartupTimeout()
          Maximum time (in seconds) that a SOC process will wait for an instance of a server object to start.
 boolean isExtensionEnabled(String name)
          Indicates whether the state of the named extension is Enabled (true) or Disabled (false).
 String serialize()
          Serializes the server object configuration into a string.
 void setCleanupTimeout(int pVal)
          Maximum time (in seconds) that a SOC process will remain active to allow its no longer used server object threads to shut down gracefully before terminating them.
 void setExtensionEnabled(String name, boolean pVal)
          Indicates whether the state of the named extension is Enabled (true) or Disabled (false).
 void setExtensionInfoByRef(String name, IPropertySet ppExtProperties)
          The extension-dependent info for the server object configuration.
 void setExtensionPropertiesByRef(String name, IPropertySet ppExtProperties)
          The extension-dependent properties for the server object configuration.
 void setInfoByRef(IPropertySet props)
          Auxiliary Information for the server objects created by the server object configuration – passive properties only.
 void setStartupTimeout(int pVal)
          Maximum time (in seconds) that a SOC process will wait for an instance of a server object to start.
 
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

serialize

String serialize()
                 throws IOException,
                        AutomationException
Serializes the server object configuration into a string.

Remarks

The Serialize and Deserialize methods allow you to serialize server object configurations to strings, then deserialize them back into server object configurations. This can be useful when copying server object configurations between two GIS servers.

Product Availability

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

Returns:
The str
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

void deserialize(String str)
                 throws IOException,
                        AutomationException
Deserializes the server object configuration from a string.

Remarks

The Serialize and Deserialize methods allow you to serialize server object configurations to strings, then deserialize them back into server object configurations. This can be useful when copying server object configurations between two GIS servers.

Product Availability

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

Parameters:
str - The str (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

IPropertySet getExtensionProperties(String name)
                                    throws IOException,
                                           AutomationException
The extension-dependent properties for the server object configuration.

Product Availability

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

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.

setExtensionPropertiesByRef

void setExtensionPropertiesByRef(String name,
                                 IPropertySet ppExtProperties)
                                 throws IOException,
                                        AutomationException
The extension-dependent properties for the server object configuration.

Product Availability

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

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

getExtensionInfo

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.

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.

setExtensionInfoByRef

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

Product Availability

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

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

isExtensionEnabled

boolean isExtensionEnabled(String name)
                           throws IOException,
                                  AutomationException
Indicates whether the state of the named extension is Enabled (true) or Disabled (false).

Product Availability

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

Parameters:
name - The name (in)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtensionEnabled

void setExtensionEnabled(String name,
                         boolean pVal)
                         throws IOException,
                                AutomationException
Indicates whether the state of the named extension is Enabled (true) or Disabled (false).

Product Availability

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

Parameters:
name - The name (in)
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCleanupTimeout

int getCleanupTimeout()
                      throws IOException,
                             AutomationException
Maximum time (in seconds) that a SOC process will remain active to allow its no longer used server object threads to shut down gracefully before terminating them.

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.

setCleanupTimeout

void setCleanupTimeout(int pVal)
                       throws IOException,
                              AutomationException
Maximum time (in seconds) that a SOC process will remain active to allow its no longer used server object threads to shut down gracefully before terminating them.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStartupTimeout

int getStartupTimeout()
                      throws IOException,
                             AutomationException
Maximum time (in seconds) that a SOC process will wait for an instance of a server object to start.

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.

setStartupTimeout

void setStartupTimeout(int pVal)
                       throws IOException,
                              AutomationException
Maximum time (in seconds) that a SOC process will wait for an instance of a server object to start.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInfo

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.

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.

setInfoByRef

void setInfoByRef(IPropertySet props)
                  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.

Parameters:
props - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.