com.esri.arcgis.gisclient
Class WMSConnectionName

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

All Implemented Interfaces:

IWMSConnectionName, com.esri.arcgis.interop.RemoteObjRef, IName, Serializable

public class WMSConnectionName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IWMSConnectionName, IName

The WMS Connection name.

Remarks

WMSConnectionName provides all the information that is required to connect to a given WMS service. To connect to a WMS service you need to provide a WMS connection URL. The connection URL should be provided by the WMS service provider.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

WMSConnectionName()
Constructs a WMSConnectionName using ArcGIS Engine.

WMSConnectionName(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
WMSConnectionName theWMSConnectionName = (WMSConnectionName) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IPropertySet	getConnectionProperties() Connection properties that will be used to connect to the WMS server.
String	getNameString() The name string of the object.
int	hashCode() the hashcode for this object
Object	open() Opens the object referred to by this name.
Object	openEx(ITrackCancel pTrackCancel) Opens the WMS Connection.
void	setConnectionProperties(IPropertySet connectionProperties) Connection properties that will be used to connect to the WMS server.
void	setNameString(String nameString) The name string of the object.

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

WMSConnectionName

public WMSConnectionName()
                  throws IOException,
                         UnknownHostException

Constructs a WMSConnectionName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

WMSConnectionName

public WMSConnectionName(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
WMSConnectionName theWMSConnectionName = (WMSConnectionName) obj;

Construct a WMSConnectionName using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to WMSConnectionName.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

setConnectionProperties

public void setConnectionProperties(IPropertySet connectionProperties)
                             throws IOException,
                                    AutomationException

Connection properties that will be used to connect to the WMS server.

Product Availability

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

Specified by:

setConnectionProperties in interface IWMSConnectionName

Parameters:

connectionProperties - 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

public IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

Connection properties that will be used to connect to the WMS server.

Remarks

ConnectionProperties is named value pairs relating to WMS service connection. This is where you would set the WMS server URL. Relevant names include “URL”, which is the minimum required, and three optional names: "VERSION', which specifies the WMS version, and two names, “USER” and “PASSWORD” that can be used when connecting to a WMS service over HTTPS.

Product Availability

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

Specified by:

getConnectionProperties in interface IWMSConnectionName

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.

openEx

public Object openEx(ITrackCancel pTrackCancel)
              throws IOException,
                     AutomationException

Opens the WMS Connection.

Remarks

OpenEx returns a WMSConnection.

Product Availability

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

Specified by:

openEx in interface IWMSConnectionName

Parameters:

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNameString

public void setNameString(String nameString)
                   throws IOException,
                          AutomationException

The name string of the object.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException

The name string of the object.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws IOException,
                   AutomationException

Opens the object referred to by this name.

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.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.