com.esri.arcgis.gisclient
Class AGSServerConnectionName

java.lang.Object
  com.esri.arcgis.gisclient.AGSServerConnectionName

All Implemented Interfaces:

IAGSServerConnectionName, IAGSServerConnectionName2, IName, IPersist, IPersistStream, java.io.Serializable

public class AGSServerConnectionName

extends java.lang.Object

implements IAGSServerConnectionName, IAGSServerConnectionName2, IName, IPersistStream

A name object for ArcGIS Server Connections.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

The name object for an AGSServerConnection. The AGSServerConnectionName for an AGSServerConnection can be persisted, for example, in a map document. An application can call the Open method on the AGSServerConnectionName after loading it from persistent storage in order to connect to and get an object reference to the GIS server or web service catalog.

See Also:

AGSServerConnection, Serialized Form

Constructor Summary

AGSServerConnectionName()
Constructs a AGSServerConnectionName using ArcGIS Engine.

AGSServerConnectionName(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IAGSServerConnectionName	getAsIAGSServerConnectionName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IAGSServerConnectionName2	getAsIAGSServerConnectionName2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IName	getAsIName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IPropertySet	getConnectionProperties() The connection properties of the AGSServerConnectionName.
java.lang.String	getConnectionString() The connection properties of the GIS server connection.
int	getConnectionType() The type of the associated GIS server connection.
java.lang.String	getNameString() The name string of the object.
java.lang.String	getServerConnectionFactoryProgID() The programmatic ID of the server connection factory.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
void	load(IStream pstm) Supported Platforms
java.lang.Object	open() Opens the object referred to by this name.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setConnectionProperties(IPropertySet ppConnProps) The connection properties of the AGSServerConnectionName.
void	setConnectionString(java.lang.String connString) The connection properties of the GIS server connection.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setServerConnectionFactoryProgID(java.lang.String progID) The programmatic ID of the server connection factory.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AGSServerConnectionName

public AGSServerConnectionName()
                        throws java.io.IOException,
                               java.net.UnknownHostException

Constructs a AGSServerConnectionName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AGSServerConnectionName

public AGSServerConnectionName(java.lang.Object obj)
                        throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a AGSServerConnectionName using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGSServerConnectionName.
AGSServerConnectionName theAGSServerConnectionName = (AGSServerConnectionName) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIAGSServerConnectionName

public IAGSServerConnectionName getAsIAGSServerConnectionName()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAGSServerConnectionName2

public IAGSServerConnectionName2 getAsIAGSServerConnectionName2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIName

public IName getAsIName()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

setConnectionProperties

public void setConnectionProperties(IPropertySet ppConnProps)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IAGSServerConnectionName

The connection properties of the AGSServerConnectionName.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

setConnectionProperties in interface IAGSServerConnectionName

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IAGSServerConnectionName

The connection properties of the AGSServerConnectionName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnectionProperties in interface IAGSServerConnectionName

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getConnectionType

public int getConnectionType()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAGSServerConnectionName

The type of the associated GIS server connection.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getConnectionType in interface IAGSServerConnectionName

Returns:

A com.esri.arcgis.gisclient.esriAGSConnectionType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getConnectionString

public java.lang.String getConnectionString()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IAGSServerConnectionName2

The connection properties of the GIS server connection.

Specified by:

getConnectionString in interface IAGSServerConnectionName2

Returns:

The connString

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setConnectionString

public void setConnectionString(java.lang.String connString)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGSServerConnectionName2

The connection properties of the GIS server connection.

Specified by:

setConnectionString in interface IAGSServerConnectionName2

Parameters:

connString - The connString (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerConnectionFactoryProgID

public java.lang.String getServerConnectionFactoryProgID()
                                                  throws java.io.IOException,
                                                         AutomationException

Description copied from interface: IAGSServerConnectionName2

The programmatic ID of the server connection factory.

Specified by:

getServerConnectionFactoryProgID in interface IAGSServerConnectionName2

Returns:

The progID

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setServerConnectionFactoryProgID

public void setServerConnectionFactoryProgID(java.lang.String progID)
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IAGSServerConnectionName2

The programmatic ID of the server connection factory.

Specified by:

setServerConnectionFactoryProgID in interface IAGSServerConnectionName2

Parameters:

progID - The progID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IName

The name string of the object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IName

The name string of the object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IName

Opens the object referred to by this name.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.