com.esri.arcgis.server
Class IServerObjectTypeProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.server.IServerObjectTypeProxy
All Implemented Interfaces:
IServerObjectType, Externalizable, Serializable
Direct Known Subclasses:
IServerObjectType2Proxy

public class IServerObjectTypeProxy
extends com.esri.arcgis.interop.Dispatch
implements IServerObjectType, Serializable

Provides access to methods, for administrators, that control the behavior and properties of a server object type.

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.

The types of server object configurations, and therefore server objects that can be created on a GIS server is one of a defined set of server object types that a GIS server can support. By default, the supported types are MapServer, GeocodeServer, GeoDataServer, GlobeServer and GPServer. The server object configuration type defines the types of server object instances that a particular server object configuration starts up and provides to applications to make use of.

The type also defines the set of properties associated with a particular server object configuration that must be specified when creating the configuration. For example, a MapServer requires a map document, a GeocodeServer requires a locator, etc

The IServerObjectType interface is a read/write interface on a server object type that allows administrators to configure new server object types to add to the server, update existing server object types, and to view the properties of a server object type.

Users and developers that are not part the the agsadmin group do not have access to this interface. An additional read only interface called IServerObjectTypeInfo is available to non-administrators which provides read only access to a subset of the server object type's properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IServerObjectTypeProxy()
           
  IServerObjectTypeProxy(Object obj)
           
protected IServerObjectTypeProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 String getCLSID()
          The GUID of the COM class corresponding to the server object type.
 String getDescription()
          Description of the server object type.
 String getName()
          Name of the server object type.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setCLSID(String pVal)
          The GUID of the COM class corresponding to the server object type.
 void setDescription(String desc)
          Description of the server object type.
 void setName(String pVal)
          Name of the server object type.
 void writeExternal(ObjectOutput out)
           
 
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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IServerObjectTypeProxy

public IServerObjectTypeProxy()

IServerObjectTypeProxy

public IServerObjectTypeProxy(Object obj)
                       throws IOException
Throws:
IOException

IServerObjectTypeProxy

protected IServerObjectTypeProxy(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 type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the server object type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setName in interface IServerObjectType
Parameters:
pVal - The pVal (in)
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 type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDescription

public void setDescription(String desc)
                    throws IOException,
                           AutomationException
Description of the server object type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDescription in interface IServerObjectType
Parameters:
desc - The desc (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

public String getCLSID()
                throws IOException,
                       AutomationException
The GUID of the COM class corresponding to the server object type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCLSID

public void setCLSID(String pVal)
              throws IOException,
                     AutomationException
The GUID of the COM class corresponding to the server object type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException