com.esri.arcgis.server
Interface IGISServerConnection

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGISServerConnection2

All Known Implementing Classes:

GISServerConnection

public interface IGISServerConnection
extends Serializable

Provides access to members that connect to a GIS server.

Superseded By

IGISServerConnection2

Description

The IGISServerConnection interface provides methods for connecting to an ArcGIS Server and properties for getting references to the server's ServerObjectManager and ServerObjectManagerAdmin for using and administering server objects, respectivly.

Remarks

In order to succesfully connect to the ArcGIS Server using the Connect method on IGISServerConnection, the user account running the application must be a member of the agsusers or agsadmin user group on the ArcGIS Server. If the account running the application is not a member of one of these groups, the Connect method will return an error.

Once connected, use the ServerObjectManager property on IGISServerConnection to get a reference on the ServerObjectManager. The ServerObjectManager provides methods for listing the server object types and server object configurations that have been configured on the server. The ServerObjectManager also provides methods for creating server contexts to provide access to and allow for the creation of server objects running within the server.

If the user account running the application is a member of the agsadmin user group on the ArcGIS Server, the ServerObjectAdmin property on IGISServerConnection can be used to get a reference on the ServerObjectAdmin. If the user account running the application is not in the agsadmin user group, the ServerObjectAdmin property will return and error.

The ServerObjectAdmin provides methods for managing server object configurations, server object types and the machines that host sever objects in the ArcGIS Server.

When To Use

Use the IGISServerConnection interface when your application needs to connect to an ArcGIS Server to either make use of and create new objects running in the server, or your application needs to perform administration tasks on the server.

Product Availability

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

Method Summary

void	connect(String machineName) Connects to the GIS server specified by the machineName.
IServerObjectAdmin	getServerObjectAdmin() The server object admin for the connected GIS server.
IServerObjectManager	getServerObjectManager() The server object manager for the connected GIS server.

Method Detail

connect

void connect(String machineName)
             throws IOException,
                    AutomationException

Connects to the GIS server specified by the machineName.

Remarks

In order to succesfully connect to the ArcGIS Server using the Connect method on IGISServerConnection, the user account running the application must be a member of the agsusers user group on the ArcGIS Server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

machineName - The machineName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerObjectManager

IServerObjectManager getServerObjectManager()
                                            throws IOException,
                                                   AutomationException

The server object manager for the connected GIS server.

Remarks

The ServerObjectManager property returns a reference to the ServerObjectManager of the ArcGIS Server. The ServerObjectManager supports interfaces for listing the server object configurations and server object types that have been configured on the server. The ServerObjectManager also supports interfaces for creating server contexts for use by the application.

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

The ServerObjectAdmin property returns a reference to the ServerObjectAdmin of the ArcGIS Server. The user account running the application must be a member of the agsadmin user group on the ArcGIS Server, to get a reference on the ServerObjectAdmin. If the user account running the application is not in the agsadmin user group, the ServerObjectAdmin property will return and error.

The ServerObjectAdmin provides methods for managing server object configurations, server object types and the machines that host sever objects in the ArcGIS Server.

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.