com.esri.arcgis.server
Class ServerObject

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerObject, IServerObjectExtensionManager, ILogSupport, IObjectActivate, IObjectConstruct, Serializable

public class ServerObject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObject, IServerObjectExtensionManager, IObjectConstruct, IObjectActivate, ILogSupport

The ServerObject object which runs within a server context in the GIS server.

Remarks

A ServerObject is a coarse-grained ArcObject, that is a high-level object that simplifies the programming model for doing certain operations and hides the fine-grained ArcObjects that do the work. Server objects support coarse-grained interfaces that support methods that do large untis of work, such as “draw a map”, or “geocode a set of addresses”. ServerObjects also have SOAP interfaces which makes it possible to expose server objects as web services that can be consumed by clients across the internet.

ArcGIS Server has to ServerObject: MapServer and GeocodeServer.

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

Field Summary

Fields inherited from interface com.esri.arcgis.system.IObjectActivate

IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy

Constructor Summary

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

Method Summary

void	activate() Activates the object.
void	construct(IPropertySet props) Two phase object construction.
void	deactivate() Deactivates the object.
boolean	equals(Object o) Compare this object with another
IServerObjectExtension	findExtensionByCLSID(String cLSID) Returns a server object extension found using a string representation of its class ID.
IServerObjectExtension	findExtensionByTypeName(String name) Returns a server object extension found using its type name.
String	getConfigurationName() Name of the server object configuration that defines the server object.
String	getTypeName() Type of the server object (MapServer or GeocodeServer).
int	hashCode() the hashcode for this object
void	initLogging(ILog log) Initializes an object with a log.

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

ServerObject

public ServerObject(Object obj)
             throws IOException

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

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

Throws:

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

getConfigurationName

public String getConfigurationName()
                            throws IOException,
                                   AutomationException

Name of the server object configuration that defines the server object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConfigurationName in interface IServerObject

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 (MapServer or GeocodeServer).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTypeName in interface IServerObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findExtensionByCLSID

public IServerObjectExtension findExtensionByCLSID(String cLSID)
                                            throws IOException,
                                                   AutomationException

Returns a server object extension found using a string representation of its class ID.

Product Availability

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

Specified by:

findExtensionByCLSID in interface IServerObjectExtensionManager

Parameters:

cLSID - The cLSID (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findExtensionByTypeName

public IServerObjectExtension findExtensionByTypeName(String name)
                                               throws IOException,
                                                      AutomationException

Returns a server object extension found using its type name.

Product Availability

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

Specified by:

findExtensionByTypeName in interface IServerObjectExtensionManager

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

construct

public void construct(IPropertySet props)
               throws IOException,
                      AutomationException

Two phase object construction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

construct in interface IObjectConstruct

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.

activate

public void activate()
              throws IOException,
                     AutomationException

Activates the object.

Specified by:

activate in interface IObjectActivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException

Deactivates the object.

Specified by:

deactivate in interface IObjectActivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initLogging

public void initLogging(ILog log)
                 throws IOException,
                        AutomationException

Initializes an object with a log.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

initLogging in interface ILogSupport

Parameters:

log - A reference to a com.esri.arcgis.system.ILog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.