com.esri.arcgis.gisclient
Interface IAGSServerConnectionAdmin

All Superinterfaces:
Serializable
All Known Implementing Classes:
AGSServerConnection

public interface IAGSServerConnectionAdmin
extends Serializable

Provides access to the server object manager, server object admin and server object configurations for the GIS server.

Remarks

The IAGSServerConnectionAdmin interface provides a bridge between the GISClient objects and the Server object library. IAGSServerConnection is supported only on AGSServerConnection objects that are connections made directly to servers over a LAN. QI for IAGSServerConnection will fail on AGSServerConnections that are connections to web service catalogs.

If the application using this interface is running as a user in the GIS server's users group agsusers, it can use the ServerObjectManager property to get a reference to the GIS server's ServerObjectManager. Using the ServerObjectManager , you can create server contexts, works with ArcObjects in the GIS server and so on.

If the application using this interface is running as a user in the GIS server's administrators group (agadmin), it can use the ServerObjectAdmin property to get a reference to the GIS server's ServerObjectAdmin. Using the ServerObjectAdmin , you can perform administration tasks such as starting and stopping serever objects, and so on.

The ServerObjectConfiguration property will return the ServerObjectConfiguration for the specified server object and type. The application must be running as a member of the GIS server's administrators group (agadmin) to succesfully get this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IServerObjectAdmin, IGISServerConnection, IServerContext, IServerObjectManager, IServerObject, GISServerConnection

Method Summary
 IServerObjectAdmin getServerObjectAdmin()
          The server object admin for the connected GIS server.
 IServerObjectConfiguration getServerObjectConfiguration(String name, String type)
          The server object configuration with the specified Name and TypeName.
 IServerObjectManager getServerObjectManager()
          The server object manager for the connected GIS server.
 

Method Detail

getServerObjectManager

IServerObjectManager getServerObjectManager()
                                            throws IOException,
                                                   AutomationException
The server object manager for the connected GIS server.

Remarks

If the application using this interface is running as a user in the GIS server's users group (agsusers), it can use the ServerObjectManager property to get a reference to the GIS server's ServerObjectManager. Using the ServerObjectManager , you can create server contexts, works with ArcObjects in the GIS server and so on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.server.IServerObjectManager
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerObjectAdmin

IServerObjectAdmin getServerObjectAdmin()
                                        throws IOException,
                                               AutomationException
The server object admin for the connected GIS server.

Remarks

If the application using this interface is running as a user in the GIS server's administrators group (agadmin), it can use the ServerObjectAdmin property to get a reference to the GIS server's ServerObjectAdmin. Using the ServerObjectAdmin , you can perform administration tasks such as starting and stopping serever objects, and so on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.server.IServerObjectAdmin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerObjectConfiguration

IServerObjectConfiguration getServerObjectConfiguration(String name,
                                                        String type)
                                                        throws IOException,
                                                               AutomationException
The server object configuration with the specified Name and TypeName.

Product Availability

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

Parameters:
name - The name (in)
type - The type (in)
Returns:
A reference to a com.esri.arcgis.server.IServerObjectConfiguration
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.