com.esri.arcgis.server
Class ServerObjectTypeInfo

java.lang.Object
  com.esri.arcgis.server.ServerObjectTypeInfo

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerObjectTypeInfo, IServerObjectTypeInfo2, IServerObjectTypeInfo3, Serializable

public class ServerObjectTypeInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectTypeInfo, IServerObjectTypeInfo2, IServerObjectTypeInfo3

The ServerObjectTypeInfo object which provides information about server object types to users without 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.

Users and developers who are not administrators also need access to the list of ServerObjectTypes and the set of their properties that are necessary for programming applications with them. Users that are members of the agsusers group, but are not members of the agsadmin user group can get information about server object types using the GetTypeInfos method on IServerObjectManager to get the ServerObjectTypeInfo objects.

ServerObjectTypeInfo objects include read only access to a subset of the server object type's properties. These properties include:

Name: the name of the server object type (e.g., MapServer, GeocodeServer)

Description: the description of the server object type

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

ServerObjectManager, ServerObjectType, IAGSServerConnectionAdmin, AGSServerConnectionName, IEnumServerObjectType, IEnumServerDirectory, AGSServerConnection, IServerConnection, AGSLocatorWorkspace, ServerObjectTypeInfo, IEnumServerObjectTypeInfo, IAGSServerObject, GeocodeServer, ServerDirectoryInfo, ServerObjectConfiguration, ServerContext, ServerObjectConfigurationStatus, IAGSServerObjectName, ServerConnection, ILocatorManager2.getAGSLocatorWorkspace(com.esri.arcgis.gisclient.IAGSServerConnectionName), IAGSServerConnectionName, IAGSEnumServerObjectName, ServerObject, IServerObjectConfigurationInfo, IServerObjectAdmin, AGSServerConnectionFactory, IAGSServerConnectionFactory, IEnumServerObjectConfigurationInfo, ILocatorWorkspaceName2.getAGSServerConnectionName(), IGISServerConnection, IAGSServerConnection, IServerContext, ServerDirectory, ServerObjectConfigurationInfo, IEnumServerMachine, ServerMachine, IServerObjectConfiguration, IServerObjectManager, IServerObjectTypeInfo, IServerMachine, IServerObject, IServerObjectType, AGSAddressLocator, GISServerConnection, AGSServerObjectName, ServerObjectAdmin, IEnumServerObjectConfiguration, Serialized Form

Constructor Summary

ServerObjectTypeInfo(Object obj)
Construct a ServerObjectTypeInfo using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
int	getConfigurationsLimit() Limits the number of configurations that can be created of this server object type.
String	getDescription() Description of the server object type.
String	getDisplayName() Display name of the server object type.
String	getName() Name of the server object type.
int	hashCode() the hashcode for this object

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

ServerObjectTypeInfo

public ServerObjectTypeInfo(Object obj)
                     throws IOException

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

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

Throws:

IOException - if there are interop problems ServerObjectTypeInfo theServerObjectTypeInfo = (ServerObjectTypeInfo) 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

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 IServerObjectTypeInfo

Returns:

The name

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 IServerObjectTypeInfo

Returns:

The desc

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

Product Availability

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

Specified by:

getDisplayName in interface IServerObjectTypeInfo2

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationsLimit

public int getConfigurationsLimit()
                           throws IOException,
                                  AutomationException

Limits the number of configurations that can be created of this server object type.

Product Availability

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

Specified by:

getConfigurationsLimit in interface IServerObjectTypeInfo3

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.