com.esri.arcgis.gisclient
Interface IAGSServerConnectionFactory

All Superinterfaces:

Serializable

All Known Subinterfaces:

IAGSServerConnectionFactory2

All Known Implementing Classes:

AGSServerConnectionFactory

public interface IAGSServerConnectionFactory
extends Serializable

Provides access to members that create and open GIS server connections and supply server connection factory information.

Superseded By

IAGSServerConnectionFactory2

Remarks

An AGSServerConnectionFactory is a dispenser of AGSServerConnection objects and allows a client to connect to an ArcGIS Server either directly over a LAN or indirectly to a web service catalog specified. An AGSServerConnection represents a GIS server or web service catalog that contains one of more server objects. Types of server object are MapServer and GeocodeServer. An AGSServerConnectionFactory maintains a pool of currently connected, active connections that are being referenced by the application. Connection properties are specified using a PropertySet object and can be saved to a connection file.

The IAGSServerConnectionFactory interface provides methods for creating AGSServerConnections based on property sets, or connection files. Use the Open method to create an AGSServerConnection based on a property set. The properties required in the property set depend on whether you are connecting directly to a GIS server over a LAN, or if you are connecting to a web service catalog. When connecting to a GIS server over the LAN, you need to set the machine property to be the name of the GIS server machine. When connecting to a web service catalog, you need to set the url property to the url of the web service catalog.

If the web service catalog you are connecting to is secure and requires a username and password, include them in the property set as the user and password properties, respectivly.

Product Availability

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

See Also:

IPropertySet

Method Summary

IAGSServerConnection

open(IPropertySet pConnectionProperties, int hWnd) Opens the GIS server connection specified by the connection properties.

Method Detail

open

IAGSServerConnection open(IPropertySet pConnectionProperties,
                          int hWnd)
                          throws IOException,
                                 AutomationException

Opens the GIS server connection specified by the connection properties.

Remarks

Use the Open method to create an AGSServerConnection based on a property set. The properties required in the property set depend on whether you are connecting directly to a GIS server over a LAN, or if you are connecting to a web service catalog. When connecting to a GIS server over the LAN, you need to set the machine property to be the name of the GIS server machine. When connecting to a web service catalog, you need to set the url property to the url of the web service catalog.

If the web service catalog you are connecting to is secure and requires a username and password, include them in the property set as the user and password properties, respectivly.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pConnectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.gisclient.IAGSServerConnection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.