com.esri.arcgis.gisclient

Class AGSServerConnection

java.lang.Object

com.esri.arcgis.gisclient.AGSServerConnection

All Implemented Interfaces:

IAGSServerConnection, IAGSServerConnection2, IAGSServerConnection3, IAGSServerConnectionAdmin, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class AGSServerConnection
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerConnection, IAGSServerConnection2, IAGSServerConnection3, IAGSServerConnectionAdmin, ISupportErrorInfo

COM Class 'AGSServerConnection'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGISClient.tlb'

Description 'The AGSServerConnection object for connecting to the GIS server and getting the ServerObjectManager and ServerObjectAdmin.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerConnection3

IID, IID20e6a647_de9e_4e4c_a301_640b9ab0d143, xxDummy

Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerConnection2

IID6921c52d_0d14_4d2c_8a80_a7873c1306ea

Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerConnection

IID657f65fd_9795_40b4_b1ce_e235ef08614c

Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerConnectionAdmin

IID, IID2609d396_4c06_4c35_9ae3_df690ed88506, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

Constructors

Constructor and Description
AGSServerConnection() Constructs a AGSServerConnection using ArcGIS Engine.
AGSServerConnection(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. AGSServerConnection theAGSServerConnection = (AGSServerConnection) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
IStream	getFile(java.lang.String uRL) Retrieves a file from the specified url.
java.lang.Object	getFileAsVariant(java.lang.String uRL) Retrieves the stream as variant from the specified url.
IEnumBSTR	getFolders(java.lang.String reserved) Returns an enumeration of folder names beneath the specified folder.
IName	getFullName() The AGSServerConnectionName object assiated with the GIS server connection.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getName() The name of the connection.
IServerObjectAdmin	getServerObjectAdmin() The server object admin for the connected GIS server.
IServerObjectConfiguration	getServerObjectConfiguration(java.lang.String name, java.lang.String type) The server object configuration with the specified Name and TypeName.
IServerObjectManager	getServerObjectManager() The server object manager for the connected GIS server.
IAGSEnumServerObjectName	getServerObjectNames() The ServerObjectNames in the GIS server.
IAGSEnumServerObjectName	getServerObjectNamesEx(java.lang.String folderName) The ServerObjectNames in the GIS server folder.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	release() Release this COM object reference
void	setFullNameByRef(IName ppNameObject) The AGSServerConnectionName object assiated with the GIS server connection.
void	setName(java.lang.String name) The name of the connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

AGSServerConnection

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

Constructs a AGSServerConnection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AGSServerConnection

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

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

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

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the connection.

Specified by:

setName in interface IAGSServerConnection

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the connection.

Specified by:

getName in interface IAGSServerConnection

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerObjectNames

public IAGSEnumServerObjectName getServerObjectNames()
                                              throws java.io.IOException,
                                                     AutomationException

The ServerObjectNames in the GIS server.

Specified by:

getServerObjectNames in interface IAGSServerConnection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The AGSServerConnectionName object assiated with the GIS server connection.

Specified by:

getFullName in interface IAGSServerConnection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFullNameByRef

public void setFullNameByRef(IName ppNameObject)
                      throws java.io.IOException,
                             AutomationException

The AGSServerConnectionName object assiated with the GIS server connection.

Specified by:

setFullNameByRef in interface IAGSServerConnection

Parameters:

ppNameObject - A reference to a com.esri.arcgis.system.IName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerObjectNamesEx

public IAGSEnumServerObjectName getServerObjectNamesEx(java.lang.String folderName)
                                                throws java.io.IOException,
                                                       AutomationException

The ServerObjectNames in the GIS server folder.

Specified by:

getServerObjectNamesEx in interface IAGSServerConnection2

Parameters:

folderName - The folderName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFolders

public IEnumBSTR getFolders(java.lang.String reserved)
                     throws java.io.IOException,
                            AutomationException

Returns an enumeration of folder names beneath the specified folder.

Specified by:

getFolders in interface IAGSServerConnection2

Parameters:

reserved - The reserved (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFile

public IStream getFile(java.lang.String uRL)
                throws java.io.IOException,
                       AutomationException

Retrieves a file from the specified url.

Specified by:

getFile in interface IAGSServerConnection3

Parameters:

uRL - The uRL (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileAsVariant

public java.lang.Object getFileAsVariant(java.lang.String uRL)
                                  throws java.io.IOException,
                                         AutomationException

Retrieves the stream as variant from the specified url.

Specified by:

getFileAsVariant in interface IAGSServerConnection3

Parameters:

uRL - The uRL (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerObjectManager

public IServerObjectManager getServerObjectManager()
                                            throws java.io.IOException,
                                                   AutomationException

The server object manager for the connected GIS server.

Specified by:

getServerObjectManager in interface IAGSServerConnectionAdmin

Returns:

A reference to a com.esri.arcgis.server.IServerObjectManager

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerObjectAdmin

public IServerObjectAdmin getServerObjectAdmin()
                                        throws java.io.IOException,
                                               AutomationException

The server object admin for the connected GIS server.

Specified by:

getServerObjectAdmin in interface IAGSServerConnectionAdmin

Returns:

A reference to a com.esri.arcgis.server.IServerObjectAdmin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerObjectConfiguration

public IServerObjectConfiguration getServerObjectConfiguration(java.lang.String name,
                                                               java.lang.String type)
                                                        throws java.io.IOException,
                                                               AutomationException

The server object configuration with the specified Name and TypeName.

Specified by:

getServerObjectConfiguration in interface IAGSServerConnectionAdmin

Parameters:

name - The name (in)

type - The type (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.