com.esri.arcgis.gisclient
Interface IAGSServerConnectionName

All Superinterfaces:
Serializable
All Known Subinterfaces:
IAGSServerConnectionName2
All Known Implementing Classes:
AGSServerConnectionName

public interface IAGSServerConnectionName
extends Serializable

Provides access to members that supply GIS server connection name information.

Superseded By

IAGSServerConnectionName2

Remarks

The IAGSConnectionName interface lets you access the properties of an AGSConnectionName. To create a new AGSConnectionName, you must set the ConnectionProperties .

The connection properties required in the property set depend on whether you are creating an AGSServerConnectionName which represents a direct connection to a GIS server over a LAN, or if it represetns a connection 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.

The ConnectionType property will return the type of connection based on the property above. The connection types are described by esriAGSConnectionType whose values are esriAGSConnectionTypeLAN and esriAGSConnectionTypeInternet.

You can QI for the IName interface on the AGSConnectionName object and call the Open method which returns an AGSServerConnection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IGPDataType.getFullName(), IPropertySet

Method Summary
 IPropertySet getConnectionProperties()
          The connection properties of the AGSServerConnectionName.
 int getConnectionType()
          The type of the associated GIS server connection.
 void setConnectionProperties(IPropertySet ppConnProps)
          The connection properties of the AGSServerConnectionName.
 

Method Detail

setConnectionProperties

void setConnectionProperties(IPropertySet ppConnProps)
                             throws IOException,
                                    AutomationException
The connection properties of the AGSServerConnectionName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppConnProps - 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.

getConnectionProperties

IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException
The connection properties of the AGSServerConnectionName.

Remarks

The connection properties required in the property set depend on whether you are creating an AGSServerConnectionName which represents a direct connection to a GIS server over a LAN, or if it represetns a connection 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

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

getConnectionType

int getConnectionType()
                      throws IOException,
                             AutomationException
The type of the associated GIS server connection.

Remarks

The ConnectionType property will return the type of connection based on the property above. The connection types are described by esriAGSConnectionType whose values are esriAGSConnectionTypeLAN and esriAGSConnectionTypeInternet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.gisclient.esriAGSConnectionType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.