org.geotools.data.arcsde
Class ConnectionConfig

java.lang.Object
  org.geotools.data.arcsde.ConnectionConfig

public class ConnectionConfig

extends java.lang.Object

Represents a set of ArcSDE database connection parameters. Instances of this class are used to validate ArcSDE connection params as in DataSourceFactory.canProcess(java.util.Map) and serves as keys for maintaining single SdeConnectionPool's by each set of connection properties

Version:

$Id: ConnectionConfig.java 18131 2006-02-21 11:11:44Z groldan $

Author:

Gabriel Rold?n

Field Summary

static java.lang.String	CONNECTION_TIMEOUT_PARAM DOCUMENT ME!
static java.lang.String	DBTYPE_PARAM must equals to "arcsde"
static java.lang.String	DBTYPE_PARAM_VALUE constant to pass "arcsde" as DBTYPE_PARAM
static java.lang.String	INSTANCE_NAME_PARAM ArcSDE databse name parameter name
static java.lang.String	MAX_CONNECTIONS_PARAM DOCUMENT ME!
static java.lang.String	MIN_CONNECTIONS_PARAM DOCUMENT ME!
static java.lang.String	NAMESPACE_PARAM namespace URI assigned to datastore instance
static java.lang.String	PASSWORD_PARAM ArcSDE database user password parameter name
static java.lang.String	PORT_NUMBER_PARAM ArcSDE server port parameter name
static java.lang.String	SERVER_NAME_PARAM ArcSDE server parameter name
protected static java.lang.String	TABLE_NAME_PARAM parameter name who's value represents the feature class for wich an SdeDataSource will be created
static java.lang.String	USER_NAME_PARAM ArcSDE database user name parameter name

Constructor Summary

ConnectionConfig(java.util.Map params)
DOCUMENT ME!

ConnectionConfig(java.lang.String dbType, java.lang.String serverName, java.lang.String portNumber, java.lang.String databaseName, java.lang.String userName, java.lang.String userPassword)
DOCUMENT ME!

Method Summary

boolean	equals(java.lang.Object o) checks for equality over another ConnectionConfig, taking in count the values of database name, user name, and port number.
java.lang.Integer	getConnTimeOut() DOCUMENT ME!
java.lang.String	getDatabaseName() DOCUMENT ME!
java.lang.Integer	getMaxConnections() DOCUMENT ME!
java.lang.Integer	getMinConnections() DOCUMENT ME!
java.net.URI	getNamespaceUri()
java.lang.Integer	getPortNumber() DOCUMENT ME!
java.lang.String	getServerName() DOCUMENT ME!
java.lang.String	getUserName() DOCUMENT ME!
java.lang.String	getUserPassword() accessor method for retrieving the user password of the ArcSDE connection properties holded here
int	hashCode() DOCUMENT ME!
java.lang.String	toString() DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

DBTYPE_PARAM

public static final java.lang.String DBTYPE_PARAM

must equals to "arcsde"

See Also:

Constant Field Values

DBTYPE_PARAM_VALUE

public static final java.lang.String DBTYPE_PARAM_VALUE

constant to pass "arcsde" as DBTYPE_PARAM

See Also:

Constant Field Values

NAMESPACE_PARAM

public static final java.lang.String NAMESPACE_PARAM

namespace URI assigned to datastore instance

See Also:

Constant Field Values

SERVER_NAME_PARAM

public static final java.lang.String SERVER_NAME_PARAM

ArcSDE server parameter name

See Also:

Constant Field Values

PORT_NUMBER_PARAM

public static final java.lang.String PORT_NUMBER_PARAM

ArcSDE server port parameter name

See Also:

Constant Field Values

INSTANCE_NAME_PARAM

public static final java.lang.String INSTANCE_NAME_PARAM

ArcSDE databse name parameter name

See Also:

Constant Field Values

USER_NAME_PARAM

public static final java.lang.String USER_NAME_PARAM

ArcSDE database user name parameter name

See Also:

Constant Field Values

PASSWORD_PARAM

public static final java.lang.String PASSWORD_PARAM

ArcSDE database user password parameter name

See Also:

Constant Field Values

MIN_CONNECTIONS_PARAM

public static final java.lang.String MIN_CONNECTIONS_PARAM

DOCUMENT ME!

See Also:

Constant Field Values

MAX_CONNECTIONS_PARAM

public static final java.lang.String MAX_CONNECTIONS_PARAM

DOCUMENT ME!

See Also:

Constant Field Values

CONNECTION_TIMEOUT_PARAM

public static final java.lang.String CONNECTION_TIMEOUT_PARAM

DOCUMENT ME!

See Also:

Constant Field Values

TABLE_NAME_PARAM

protected static final java.lang.String TABLE_NAME_PARAM

parameter name who's value represents the feature class for wich an SdeDataSource will be created

See Also:

Constant Field Values

Task:

TODO: should this constant be moved to the SdeDataSource class? since SdeConnectionConfig thoes not validates the table param

Constructor Detail

ConnectionConfig

public ConnectionConfig(java.util.Map params)
                 throws java.lang.NullPointerException,
                        java.lang.IllegalArgumentException

DOCUMENT ME!

Parameters:

params -

Throws:

java.lang.NullPointerException - if at least one mandatory parameter is

java.lang.IllegalArgumentException - if at least one mandatory parameter is present but has no a "valid" value.

ConnectionConfig

public ConnectionConfig(java.lang.String dbType,
                        java.lang.String serverName,
                        java.lang.String portNumber,
                        java.lang.String databaseName,
                        java.lang.String userName,
                        java.lang.String userPassword)
                 throws java.lang.NullPointerException,
                        java.lang.IllegalArgumentException

DOCUMENT ME!

Parameters:

dbType -

serverName - DOCUMENT ME!

portNumber - DOCUMENT ME!

databaseName - DOCUMENT ME!

userName - DOCUMENT ME!

userPassword - DOCUMENT ME!

Throws:

java.lang.NullPointerException

java.lang.IllegalArgumentException

Method Detail

getNamespaceUri

public java.net.URI getNamespaceUri()

getDatabaseName

public java.lang.String getDatabaseName()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getPortNumber

public java.lang.Integer getPortNumber()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getServerName

public java.lang.String getServerName()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getUserName

public java.lang.String getUserName()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getUserPassword

public java.lang.String getUserPassword()

accessor method for retrieving the user password of the ArcSDE connection properties holded here

Returns:

the ArcSDE user password

hashCode

public int hashCode()

DOCUMENT ME!

Returns:

DOCUMENT ME!

equals

public boolean equals(java.lang.Object o)

checks for equality over another ConnectionConfig, taking in count the values of database name, user name, and port number.

Parameters:

o - DOCUMENT ME!

Returns:

DOCUMENT ME!

getConnTimeOut

public java.lang.Integer getConnTimeOut()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getMaxConnections

public java.lang.Integer getMaxConnections()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getMinConnections

public java.lang.Integer getMinConnections()

DOCUMENT ME!

Returns:

DOCUMENT ME!

toString

public java.lang.String toString()

DOCUMENT ME!

Returns:

DOCUMENT ME!