com.esri.arcgis.server

Class ServerCluster3

java.lang.Object

com.esri.arcgis.server.ServerConnection

com.esri.arcgis.server.ServerCluster3

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerConnection, java.io.Serializable

public class ServerCluster3
extends ServerConnection
implements java.io.Serializable

Use this class to get a ServerConnection object or IServerObjectManager interface to a SOM machine based on the clustering configuration. You can choose between various types defined in ServerClusterType class. This class will attempt to give you a connection to SOM from the input list of SOM machines. This class is thread safe and does not block other threads for long periods of time which could be caused due to communication error.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.server.IServerConnection

IID, IID425b0a5b_bf1b_4f0e_9e75_37324a12e5f9, xxDummy

Constructor Summary

Constructors

Constructor and Description
ServerCluster3(java.util.Collection soms, ServerClusterType serverClusterType) Constructor that takes in a list of machine names and the clustering algorithm.
ServerCluster3(java.util.Collection soms, ServerClusterType serverClusterType, java.lang.String domain, java.lang.String username, java.lang.String password) Constructor that takes in a list of machine names, the clustering algorithm and user credentials to use while attempting to connect to a SOM.

Method Summary

Modifier and Type	Method and Description
void	addSOM(java.lang.String som) Add SOM to list
IServer	getAsIServer() Access this COM class's com.esri.arcgis.server.IServer interface
java.lang.String	getHostName() Returns the name of the server machine to which this connection was created.
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.
protected java.lang.String	getJintegraVersion()
java.lang.Object	getPropertyByName(java.lang.String name) getPropertyByName.
java.lang.Object	getPropertyByName(java.lang.String name, java.lang.Object rhs) getPropertyByName.
int	getReconnectTimeInMins() Function to get the time value in mins after which time this class will attempt to reconnect to a bad SOM.
int	getServerClusterSize() Returns the cluster size.
ServerClusterType	getServerClusterType() Return the ServerClusterType configured for this class.
ServerCluster3	getServerConnection() Method that returns a ServerCluster, that has a connection to the SOM machine based on the ServerClusterType that has been configured on this class.
IServerObjectAdmin	getServerObjectAdmin() getServerObjectAdmin.
IServerObjectManager	getServerObjectManager() getServerObjectManager.
IServerObjectManager	getServerObjectManager2(java.lang.String userInfo) getServerObjectManager2.
java.lang.String	getUserDomain() Return the user domain that is used to connect to a SOM.
java.lang.String	getUserName() Return the username that is used to connect to a SOM.
java.lang.String	getUserPassword() Return the user password that is used to connect to a SOM.
int	hashCode() the hashcode for this object
boolean	hasServer() Returns true if there is atleast 1 SOM in the list.
java.lang.Object	invokeMethodByName(java.lang.String name, java.lang.Object[] parameters) invokeMethodByName.
java.lang.String	peek() This method returns the name of the host to which this class will attempt to connect next (for any thread) based on the configured clustering algorithm without actually making a connection.
void	release() Release this COM object reference
void	removeSOM(java.lang.String som) Remove a SOM from the list
void	setConfigurationToCheck(java.lang.String serverObjectName, java.lang.String serverObjectType) Method to set configuration information to check when connected to SOMs.
void	setCredentials(java.lang.String domain, java.lang.String username, java.lang.String password) Set the credentials to use while connecting to the SOM
void	setReconnectTimeInMins(int timeInMins) Function to set a time value in mins after which time this class will attempt to reconnect to a bad SOM.

Methods inherited from class com.esri.arcgis.server.ServerConnection

bindUsingMoniker, connect, connect, equals, getActiveObject, getClsid

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerCluster3

public ServerCluster3(java.util.Collection soms,
                      ServerClusterType serverClusterType)
               throws java.net.UnknownHostException,
                      java.io.IOException

Constructor that takes in a list of machine names and the clustering algorithm.

Parameters:

Collection - - list of SOM machine names

ServerClusterType - - clustering algorithm

Throws:

java.io.IOException

java.net.UnknownHostException

ServerCluster3

public ServerCluster3(java.util.Collection soms,
                      ServerClusterType serverClusterType,
                      java.lang.String domain,
                      java.lang.String username,
                      java.lang.String password)
               throws java.net.UnknownHostException,
                      java.io.IOException

Constructor that takes in a list of machine names, the clustering algorithm and user credentials to use while attempting to connect to a SOM.

Parameters:

soms - - list of SOM machines for clustering.

serverClusterType - - clustering algorithm.

domain - - String representing the domain of the user

username - - String representing the name of the user

password - - String representing the password of the user

Throws:

java.io.IOException

java.net.UnknownHostException

Method Detail

setConfigurationToCheck

public void setConfigurationToCheck(java.lang.String serverObjectName,
                                    java.lang.String serverObjectType)

Method to set configuration information to check when connected to SOMs. While handing out connections to SOMs this class will test if the set configuration information is available with the SOM. If not, it will log an exception and search for the next SOM. If this information is not set, this class will not server for any configuration.

Parameters:

serverObjectName - - String representing the server object.

serverObjectType - - String representing the server object type.

setReconnectTimeInMins

public void setReconnectTimeInMins(int timeInMins)

Function to set a time value in mins after which time this class will attempt to reconnect to a bad SOM.

getReconnectTimeInMins

public int getReconnectTimeInMins()

Function to get the time value in mins after which time this class will attempt to reconnect to a bad SOM.

Returns:

int

getServerConnection

public ServerCluster3 getServerConnection()
                                   throws SOMNotAvailableException

Method that returns a ServerCluster, that has a connection to the SOM machine based on the ServerClusterType that has been configured on this class. If all the SOM machines in the cluster are down/cannot be reached this method will throw an exception.

Throws:

SOMNotAvailableException - - when there are no SOM machines to connect to.

peek

public java.lang.String peek()

This method returns the name of the host to which this class will attempt to connect next (for any thread) based on the configured clustering algorithm without actually making a connection. However, the class does not guarantee that the next connection it will hand out will be to the same host that is returned by this method.

Returns:

String - name of the SOM machine to which it could attempt to connect next or returns null if no active SOM could be found.

addSOM

public void addSOM(java.lang.String som)
            throws java.lang.NullPointerException

Add SOM to list

Throws:

java.lang.NullPointerException

removeSOM

public void removeSOM(java.lang.String som)
               throws java.lang.NullPointerException

Remove a SOM from the list

Throws:

java.lang.NullPointerException

setCredentials

public void setCredentials(java.lang.String domain,
                           java.lang.String username,
                           java.lang.String password)

Set the credentials to use while connecting to the SOM

getServerClusterType

public ServerClusterType getServerClusterType()

Return the ServerClusterType configured for this class.

getUserName

public java.lang.String getUserName()

Return the username that is used to connect to a SOM.

getUserPassword

public java.lang.String getUserPassword()

Return the user password that is used to connect to a SOM.

getUserDomain

public java.lang.String getUserDomain()

Return the user domain that is used to connect to a SOM.

hasServer

public boolean hasServer()

Returns true if there is atleast 1 SOM in the list.

getServerClusterSize

public int getServerClusterSize()

Returns the cluster size.

getServerObjectAdmin

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

Description copied from class: ServerConnection

getServerObjectAdmin. Gets the server object admin for the connected GIS server.

Specified by:

getServerObjectAdmin in interface IServerConnection

Overrides:

getServerObjectAdmin in class ServerConnection

Returns:

return value. An reference to a com.esri.arcgis.server.IServerObjectAdmin

Throws:

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

AutomationException - If the remote server throws an exception.

getServerObjectManager

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

Description copied from class: ServerConnection

getServerObjectManager. Gets the server object manager for the connected GIS server.

Specified by:

getServerObjectManager in interface IServerConnection

Overrides:

getServerObjectManager in class ServerConnection

Returns:

return value. An reference to a com.esri.arcgis.server.IServerObjectManager

Throws:

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

AutomationException - If the remote server throws an exception.

getServerObjectManager2

public IServerObjectManager getServerObjectManager2(java.lang.String userInfo)
                                             throws java.io.IOException,
                                                    AutomationException

Description copied from class: ServerConnection

getServerObjectManager2. Gets the server object manager for the connected GIS server.

Overrides:

getServerObjectManager2 in class ServerConnection

Parameters:

userInfo - String

Returns:

return value. An reference to a com.esri.arcgis.server.IServerObjectManager

Throws:

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

AutomationException - If the remote server throws an exception.

getAsIServer

public IServer getAsIServer()

Description copied from class: ServerConnection

Access this COM class's com.esri.arcgis.server.IServer interface

Overrides:

getAsIServer in class ServerConnection

getPropertyByName

public java.lang.Object getPropertyByName(java.lang.String name,
                                          java.lang.Object rhs)
                                   throws java.lang.NoSuchFieldException,
                                          java.io.IOException,
                                          AutomationException

Description copied from class: ServerConnection

getPropertyByName. Get the value of a property dynamically at run-time, based on its name and a parameter

Overrides:

getPropertyByName in class ServerConnection

Parameters:

name - The name of the property to get.

rhs - A parameter used when getting the proxy

Returns:

return value. The value of the property.

Throws:

java.lang.NoSuchFieldException - If the property does not exit.

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

AutomationException - If the remote server throws an exception.

getPropertyByName

public java.lang.Object getPropertyByName(java.lang.String name)
                                   throws java.lang.NoSuchFieldException,
                                          java.io.IOException,
                                          AutomationException

Description copied from class: ServerConnection

getPropertyByName. Get the value of a property dynamically at run-time, based on its name

Overrides:

getPropertyByName in class ServerConnection

Parameters:

name - The name of the property to get.

Returns:

return value. The value of the property.

Throws:

java.lang.NoSuchFieldException - If the property does not exit.

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

AutomationException - If the remote server throws an exception.

invokeMethodByName

public java.lang.Object invokeMethodByName(java.lang.String name,
                                           java.lang.Object[] parameters)
                                    throws java.lang.NoSuchMethodException,
                                           java.io.IOException,
                                           AutomationException

Description copied from class: ServerConnection

invokeMethodByName. Invoke a method dynamically at run-time

Overrides:

invokeMethodByName in class ServerConnection

Parameters:

name - The name of the method to be invoked

parameters - One element for each parameter. Use primitive type wrappers to pass primitive types (eg Integer to pass an int).

Returns:

return value. The value returned by the method (null if none).

Throws:

java.lang.NoSuchMethodException - If the method does not exit.

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

AutomationException - If the remote server throws an exception.

getHostName

public java.lang.String getHostName()

Description copied from class: ServerConnection

Returns the name of the server machine to which this connection was created.

Overrides:

getHostName in class ServerConnection

Returns:

String - name of the server machine

getJintegraDispatch

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

Description copied from class: ServerConnection

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

Overrides:

getJintegraDispatch in class ServerConnection

Returns:

the COM object reference

getJintegraVersion

protected java.lang.String getJintegraVersion()

Overrides:

getJintegraVersion in class ServerConnection

hashCode

public int hashCode()

Description copied from class: ServerConnection

the hashcode for this object

Overrides:

hashCode in class ServerConnection

release

public void release()

Description copied from class: ServerConnection

Release this COM object reference

Specified by:

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

Overrides:

release in class ServerConnection