com.esri.arcgis.server
Class IServerObjectConfiguration2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.server.IServerObjectConfigurationProxy
          com.esri.arcgis.server.IServerObjectConfiguration2Proxy

All Implemented Interfaces:

IServerObjectConfiguration, IServerObjectConfiguration2, Externalizable, Serializable

Direct Known Subclasses:

IServerObjectConfiguration3Proxy

public class IServerObjectConfiguration2Proxy
extends IServerObjectConfigurationProxy
implements IServerObjectConfiguration2, 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.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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).
void	removeListener(String iidStr, Object theListener)
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 class com.esri.arcgis.server.IServerObjectConfigurationProxy

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

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

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IServerObjectConfiguration2Proxy

public IServerObjectConfiguration2Proxy()

IServerObjectConfiguration2Proxy

public IServerObjectConfiguration2Proxy(Object obj)
                                 throws IOException

Throws:

IOException

IServerObjectConfiguration2Proxy

protected IServerObjectConfiguration2Proxy(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 IServerObjectConfigurationProxy

Throws:

IOException

removeListener

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

Overrides:

removeListener in class IServerObjectConfigurationProxy

Throws:

IOException

serialize

public 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.

Specified by:

serialize in interface IServerObjectConfiguration2

Returns:

The str

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public 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.

Specified by:

deserialize in interface IServerObjectConfiguration2

Parameters:

str - The str (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public 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.

Specified by:

getExtensionProperties in interface IServerObjectConfiguration2

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

public 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.

Specified by:

setExtensionPropertiesByRef in interface IServerObjectConfiguration2

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

public 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.

Specified by:

getExtensionInfo in interface IServerObjectConfiguration2

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

public 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.

Specified by:

setExtensionInfoByRef in interface IServerObjectConfiguration2

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

public 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.

Specified by:

isExtensionEnabled in interface IServerObjectConfiguration2

Parameters:

name - The name (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtensionEnabled

public 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.

Specified by:

setExtensionEnabled in interface IServerObjectConfiguration2

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

public 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.

Specified by:

getCleanupTimeout in interface IServerObjectConfiguration2

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCleanupTimeout

public 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.

Specified by:

setCleanupTimeout in interface IServerObjectConfiguration2

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartupTimeout

public 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.

Specified by:

getStartupTimeout in interface IServerObjectConfiguration2

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartupTimeout

public 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.

Specified by:

setStartupTimeout in interface IServerObjectConfiguration2

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInfo

public 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.

Specified by:

getInfo in interface IServerObjectConfiguration2

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

public 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.

Specified by:

setInfoByRef in interface IServerObjectConfiguration2

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.