com.esri.arcgis.server
Class IServerObjectConfigurationInfoProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.server.IServerObjectConfigurationInfoProxy
All Implemented Interfaces:
IServerObjectConfigurationInfo, Externalizable, Serializable
Direct Known Subclasses:
IServerObjectConfigurationInfo2Proxy

public class IServerObjectConfigurationInfoProxy
extends com.esri.arcgis.interop.Dispatch
implements IServerObjectConfigurationInfo, Serializable

Provides access to properties of a server object configuration.

Remarks

The ArcGIS Server manages a set of server objects running across one or more host (container) machines. How those server objects are configured and run is defined by a set of server object configurations. Server object configurations can be added, removed and modified by users or developers who are members of the agsadmin users group, and therfore have administrator priviliges on the ArcGIS Server.

Users and developers who are not administrators also need access to the list of server object configurations and the set of their properties that are necessary for programming applications with them. Users that are members of the agsusers user group, but are not members of the agsadmin user group can get information about server object configurations using the GetConfigurtationInfos method on IServerObjectManager to get the IServerObjectConfigurationInfo interface. Note that GetConfigurtationInfos returns only server object configurations that are started.

IServerObjectConfigurationInfo provides read only access to a subset of the server object configuration's properties. These properties include:

Name: the name of the server object configuration

TypeName: the type of server object configuration (for example MapServer, GeocodeServer)

Description: the description of the server object configuration

IsPooled: inidicates whether the server objects described by this configuration are pooled or non-pooled

The properties listed above are those necessary for developers of server applications to make use of the various server objects configured on the GIS server.

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
  IServerObjectConfigurationInfoProxy()
           
  IServerObjectConfigurationInfoProxy(Object obj)
           
protected IServerObjectConfigurationInfoProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 String getDescription()
          Description of the server object configuration.
 String getName()
          Name of the server object configuration.
 String getTypeName()
          Type of the server object configuration (MapServer or GeocodeServer).
 boolean isPooled()
          Indicates whether the server objects defined by this configuration are pooled.
 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

IServerObjectConfigurationInfoProxy

public IServerObjectConfigurationInfoProxy()

IServerObjectConfigurationInfoProxy

public IServerObjectConfigurationInfoProxy(Object obj)
                                    throws IOException
Throws:
IOException

IServerObjectConfigurationInfoProxy

protected IServerObjectConfigurationInfoProxy(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

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the server object configuration.

Remarks

The Name property in combination with the TypeName property is used to identify a server object configuration in methods such as CreateServerContext.

Name is case-sensitive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IServerObjectConfigurationInfo
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTypeName

public String getTypeName()
                   throws IOException,
                          AutomationException
Type of the server object configuration (MapServer or GeocodeServer).

Remarks

The TypeName property indicates the type of server object that this configuration creates and runs. Examples are MapServer and GeocodeServer.

The TypeName property in combination with the Name property is used to identify a server object configuration in methods such as CreateServerContext.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTypeName in interface IServerObjectConfigurationInfo
Returns:
The typeName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
Description of the server object configuration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDescription in interface IServerObjectConfigurationInfo
Returns:
The desc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPooled

public boolean isPooled()
                 throws IOException,
                        AutomationException
Indicates whether the server objects defined by this configuration are pooled.

Remarks

Server objects can be either pooled or non-pooled. Pooled server objects can be shared accross multiple sessions and applications and are held onto by an application for the duration of a single request. Pooled server objects are meant for applications that make stateless use of those objects.

Non-pooled server objects are dedicated to a single application session and are held onto for the duration of an application session. Non-pooled server objects are not shared between application session, and are meant for applications that make stateful use of those objects.

The IsPooled property indicates if the server objects created by this server object configuration are pooled or non-pooled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isPooled in interface IServerObjectConfigurationInfo
Returns:
The isPooled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.