com.esri.arcgis.server
Class ServerObjectExtensionType

java.lang.Object
  extended by com.esri.arcgis.server.ServerObjectExtensionType
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IServerObjectExtensionType, IServerObjectExtensionType2, IServerObjectExtensionType3, Serializable

public class ServerObjectExtensionType
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectExtensionType, IServerObjectExtensionType2, IServerObjectExtensionType3

The ServerObjectExtensionType object which provides information about server object extension types to users with administrative privileges to the ArcGIS server.

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.

A ServerObjectType is the type of a server object. 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 and GeocodeServer. 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 ServerObjectType 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.

You must be connected to the GIS server as an administrator to access ServerType objects. A subset of properties of a ServerObjectType are available to non administators via the ServerObjectTypeInfo object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ServerObjectExtensionType(Object obj)
          Construct a ServerObjectExtensionType using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getCLSID()
          The class ID of the extension type.
 String getConfigurationFactoryCLSID()
          Configuration Factory CLSID.
 String getDescription()
          The description of the extension type.
 String getDisplayName()
          Display name of the server object extension type.
 IPropertySet getInfo()
          Auxiliary information for the server objects extension type passive properties only.
 String getName()
          The name of the extension type.
 IPropertySet getProperties()
          Properties for the server object extension type.
 int hashCode()
          the hashcode for this object
 void setCLSID(String pVal)
          The class ID of the extension type.
 void setConfigurationFactoryCLSID(String pVal)
          Configuration Factory CLSID.
 void setDescription(String desc)
          The description of the extension type.
 void setDisplayName(String pVal)
          Display name of the server object extension type.
 void setInfoByRef(IPropertySet props)
          Auxiliary information for the server objects extension type passive properties only.
 void setName(String pVal)
          The name of the extension type.
 void setPropertiesByRef(IPropertySet props)
          Properties for the server object extension type.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ServerObjectExtensionType

public ServerObjectExtensionType(Object obj)
                          throws IOException
Construct a ServerObjectExtensionType using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ServerObjectExtensionType.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ServerObjectExtensionType o = (ServerObjectExtensionType)obj; // will not work

ServerObjectExtensionType o = new ServerObjectExtensionType(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ServerObjectExtensionType theServerObjectExtensionType = (ServerObjectExtensionType) obj;
Method Detail

equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the extension type.

Product Availability

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

Specified by:
getName in interface IServerObjectExtensionType
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
The name of the extension type.

Product Availability

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

Specified by:
setName in interface IServerObjectExtensionType
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
The description of the extension type.

Product Availability

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

Specified by:
getDescription in interface IServerObjectExtensionType
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
The description of the extension type.

Product Availability

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

Specified by:
setDescription in interface IServerObjectExtensionType
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 class ID of the extension type.

Product Availability

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

Specified by:
getCLSID in interface IServerObjectExtensionType
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 class ID of the extension type.

Product Availability

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

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

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException
Display name of the server object extension type.

Product Availability

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

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

setDisplayName

public void setDisplayName(String pVal)
                    throws IOException,
                           AutomationException
Display name of the server object extension type.

Product Availability

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

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

getProperties

public IPropertySet getProperties()
                           throws IOException,
                                  AutomationException
Properties for the server object extension type.

Product Availability

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

Specified by:
getProperties in interface IServerObjectExtensionType3
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.

setPropertiesByRef

public void setPropertiesByRef(IPropertySet props)
                        throws IOException,
                               AutomationException
Properties for the server object extension type.

Product Availability

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

Specified by:
setPropertiesByRef in interface IServerObjectExtensionType3
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.

getInfo

public IPropertySet getInfo()
                     throws IOException,
                            AutomationException
Auxiliary information for the server objects extension type passive properties only.

Product Availability

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

Specified by:
getInfo in interface IServerObjectExtensionType3
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 extension type passive properties only.

Product Availability

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

Specified by:
setInfoByRef in interface IServerObjectExtensionType3
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.

getConfigurationFactoryCLSID

public String getConfigurationFactoryCLSID()
                                    throws IOException,
                                           AutomationException
Configuration Factory CLSID.

Product Availability

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

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

setConfigurationFactoryCLSID

public void setConfigurationFactoryCLSID(String pVal)
                                  throws IOException,
                                         AutomationException
Configuration Factory CLSID.

Product Availability

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

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