com.esri.arcgis.gisclient

Class AGSServerConnectionFactory

java.lang.Object

com.esri.arcgis.gisclient.AGSServerConnectionFactory

All Implemented Interfaces:

IAGSServerConnectionFactory, IAGSServerConnectionFactory2, IAGSServerConnectionFactory3, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class AGSServerConnectionFactory
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerConnectionFactory, IAGSServerConnectionFactory2, IAGSServerConnectionFactory3

COM Class 'AGSServerConnectionFactory'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriGISClient.tlb'

Description 'A factory object for ArcGIS Server Connections.' 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.IAGSServerConnectionFactory3

IID, IID02d56c6d_9134_42c7_b6b0_6804a125b7a9, xxDummy

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

IID0264ca94_b0eb_435f_9d3a_5fcc5da0fbae

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

IID6047c9fc_2d91_420a_a5a2_eb36b7e2fea2

Constructor Summary

Constructors

Constructor and Description
AGSServerConnectionFactory() Constructs a AGSServerConnectionFactory using ArcGIS Engine.
AGSServerConnectionFactory(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. AGSServerConnectionFactory theAGSServerConnectionFactory = (AGSServerConnectionFactory) 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.
int	getDefaultHttpTimeout() The default timeout for http requests to the server (in seconds).
IEnumAGSServerConnectionName	getHostedServers(int hWnd) Returns server object names for the hosted servers accessible to the user.
IAGSServerConnectionName	getInServerConnectionName() Returns a server connection name that can be used to connect to the server from within a server process.
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.
int	hashCode() the hashcode for this object
IAGSServerConnection	open(IPropertySet pConnectionProperties, int hWnd) Opens the GIS server connection specified by the connection properties.
IAGSServerConnection	openFromFile(java.lang.String fileName, int hWnd) Opens the server connection specified by the given file name.
IPropertySet	readConnectionPropertiesFromFile(java.lang.String fileName) The connection properties from the specified file.
void	release() Release this COM object reference
void	setDefaultHttpTimeout(int seconds) The default timeout for http requests to the server (in seconds).

Methods inherited from class java.lang.Object

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

Constructor Detail

AGSServerConnectionFactory

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

Constructs a AGSServerConnectionFactory using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AGSServerConnectionFactory

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

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

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

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

open

public IAGSServerConnection open(IPropertySet pConnectionProperties,
                                 int hWnd)
                          throws java.io.IOException,
                                 AutomationException

Opens the GIS server connection specified by the connection properties.

Specified by:

open in interface IAGSServerConnectionFactory

Parameters:

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

hWnd - The hWnd (A COM typedef) (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFromFile

public IAGSServerConnection openFromFile(java.lang.String fileName,
                                         int hWnd)
                                  throws java.io.IOException,
                                         AutomationException

Opens the server connection specified by the given file name.

Specified by:

openFromFile in interface IAGSServerConnectionFactory2

Parameters:

fileName - The fileName (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readConnectionPropertiesFromFile

public IPropertySet readConnectionPropertiesFromFile(java.lang.String fileName)
                                              throws java.io.IOException,
                                                     AutomationException

The connection properties from the specified file.

Specified by:

readConnectionPropertiesFromFile in interface IAGSServerConnectionFactory2

Parameters:

fileName - The fileName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultHttpTimeout

public void setDefaultHttpTimeout(int seconds)
                           throws java.io.IOException,
                                  AutomationException

The default timeout for http requests to the server (in seconds).

Specified by:

setDefaultHttpTimeout in interface IAGSServerConnectionFactory2

Parameters:

seconds - The seconds (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultHttpTimeout

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

The default timeout for http requests to the server (in seconds).

Specified by:

getDefaultHttpTimeout in interface IAGSServerConnectionFactory2

Returns:

The seconds

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHostedServers

public IEnumAGSServerConnectionName getHostedServers(int hWnd)
                                              throws java.io.IOException,
                                                     AutomationException

Returns server object names for the hosted servers accessible to the user.

Specified by:

getHostedServers in interface IAGSServerConnectionFactory3

Parameters:

hWnd - The hWnd (A COM typedef) (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInServerConnectionName

public IAGSServerConnectionName getInServerConnectionName()
                                                   throws java.io.IOException,
                                                          AutomationException

Returns a server connection name that can be used to connect to the server from within a server process. Fails if run outside a server process.

Specified by:

getInServerConnectionName in interface IAGSServerConnectionFactory3

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.