com.esri.arcgis.arcweb
Class ArcWebConnection

java.lang.Object
  extended by com.esri.arcgis.arcweb.ArcWebConnection
All Implemented Interfaces:
IArcWebConnection, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class ArcWebConnection
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebConnection, ISupportErrorInfo

A connection singleton to ArcWeb services.

Product Availability

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

Singleton:

This type is a singleton.

See Also:
Serialized Form

Constructor Summary
ArcWebConnection()
          Constructs a ArcWebConnection using ArcGIS Engine.
ArcWebConnection(Object obj)
          Construct a ArcWebConnection using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void connect(String userName, String password, boolean useHTTPS, ITrackCancel pCancelTracker)
          Connects to an ArcWeb server.
 void disconnect()
          Disconnects an existing ArcWeb connection.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 String getVersion()
          Version number of the Arcweb service.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isSecure()
          Indicates if the connection is secure.
 boolean isValid()
          Indicates if the connection is valid.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ArcWebConnection

public ArcWebConnection()
                 throws IOException,
                        UnknownHostException
Constructs a ArcWebConnection using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ArcWebConnection

public ArcWebConnection(Object obj)
                 throws IOException
Construct a ArcWebConnection using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebConnection.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems ArcWebConnection theArcWebConnection = (ArcWebConnection) obj;
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

connect

public void connect(String userName,
                    String password,
                    boolean useHTTPS,
                    ITrackCancel pCancelTracker)
             throws IOException,
                    AutomationException
Connects to an ArcWeb server.

Product Availability

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

Specified by:
connect in interface IArcWebConnection
Parameters:
userName - The userName (in)
password - The password (in)
useHTTPS - The useHTTPS (in)
pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException
Disconnects an existing ArcWeb connection.

Product Availability

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

Specified by:
disconnect in interface IArcWebConnection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException
Indicates if the connection is valid.

Product Availability

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

Specified by:
isValid in interface IArcWebConnection
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVersion

public String getVersion()
                  throws IOException,
                         AutomationException
Version number of the Arcweb service.

Product Availability

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

Specified by:
getVersion in interface IArcWebConnection
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSecure

public boolean isSecure()
                 throws IOException,
                        AutomationException
Indicates if the connection is secure.

Product Availability

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

Specified by:
isSecure in interface IArcWebConnection
Returns:
The pSecure
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.