xal.tools.database

Class ConnectionDictionary

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

xal.tools.database.ConnectionDictionary

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class ConnectionDictionary
extends java.util.Properties

ConnectionDictionary contains properties that can be used to establish a database connection. It should contain at least the database URL, user name and password. A default connection dictionary can be fetched from a file specified in the user's preferences.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATABASE_ADAPTOR_KEY
static java.lang.String	PASSWORD_KEY
static java.lang.String	URL_KEY
static java.lang.String	USER_KEY

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
ConnectionDictionary() Constructor

Method Summary

Modifier and Type	Method and Description
static ConnectionDictionary	defaultDictionary() Get the connection dictionary from the file specified in the user's preferences.
DatabaseAdaptor	getDatabaseAdaptor() Get the database adaptor to use
static ConnectionDictionary	getInstance() Get the connection dictionary from the URL specified in the user's preferences.
static ConnectionDictionary	getInstance(java.lang.String accountName) Get the connection dictionary from the URL specified in the user's preferences and for the specified account.
static ConnectionDictionary	getInstance(java.lang.String accountName, java.lang.String serverName) Get the connection dictionary from the URL specified in the user's preferences and for the specified account and server.
java.lang.String	getPassword() Get the user password for connecting
static ConnectionDictionary	getPreferredInstance(java.lang.String... accountNames) Get the available connection dictionary which is the most preferred
java.lang.String	getURLSpec() Get the connection URL
java.lang.String	getUser() Get the user name for connecting
boolean	hasRequiredInfo() Determine if the dictionary is sufficiently complete regardless whether the data is right or wrong.
void	setDatabaseAdaptorClass(java.lang.Class<?> databaseAdaptorClass) Set the database adaptor class
void	setDatabaseAdaptorClass(java.lang.String className) Set the database adaptor class
void	setPassword(java.lang.String password) Set the password
void	setURLSpec(java.lang.String urlSpec) Set the URL spec
void	setUser(java.lang.String userID) Set the user ID

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

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

Field Detail

USER_KEY

public static final java.lang.String USER_KEY

See Also:

Constant Field Values

PASSWORD_KEY

public static final java.lang.String PASSWORD_KEY

See Also:

Constant Field Values

URL_KEY

public static final java.lang.String URL_KEY

See Also:

Constant Field Values

DATABASE_ADAPTOR_KEY

public static final java.lang.String DATABASE_ADAPTOR_KEY

See Also:

Constant Field Values

Constructor Detail

ConnectionDictionary

public ConnectionDictionary()

Constructor

Method Detail

defaultDictionary

public static ConnectionDictionary defaultDictionary()

Get the connection dictionary from the file specified in the user's preferences.

Returns:

the user's default connection dictionary

getInstance

public static ConnectionDictionary getInstance()

Get the connection dictionary from the URL specified in the user's preferences.

Returns:

the user's default connection dictionary

getInstance

public static ConnectionDictionary getInstance(java.lang.String accountName)

Get the connection dictionary from the URL specified in the user's preferences and for the specified account.

Parameters:

accountName - name of the account for which to initializae the connection dictionary (or null to use the default account if any)

Returns:

the user's default connection dictionary

getPreferredInstance

public static ConnectionDictionary getPreferredInstance(java.lang.String... accountNames)

Get the available connection dictionary which is the most preferred

Parameters:

accountNames - ordered (most preferred is first) accounts to search among

getInstance

public static ConnectionDictionary getInstance(java.lang.String accountName,
                                               java.lang.String serverName)

Get the connection dictionary from the URL specified in the user's preferences and for the specified account and server.

Parameters:

accountName - name of the account for which to initializae the connection dictionary (or null to use the default account if any)

serverName - name of the database server for which to initialize the connection dictionary (or null to use the default server if any)

Returns:

the user's default connection dictionary

hasRequiredInfo

public boolean hasRequiredInfo()

Determine if the dictionary is sufficiently complete regardless whether the data is right or wrong.

Returns:

true if the dictionary contains the user name, password and database URL (database adaptor is optional)

getUser

public java.lang.String getUser()

Get the user name for connecting

Returns:

the user name

setUser

public void setUser(java.lang.String userID)

Set the user ID

Parameters:

userID - The user ID

getPassword

public java.lang.String getPassword()

Get the user password for connecting

Returns:

the user password

setPassword

public void setPassword(java.lang.String password)

Set the password

Parameters:

password - the password

getURLSpec

public java.lang.String getURLSpec()

Get the connection URL

Returns:

the connection URL

setURLSpec

public void setURLSpec(java.lang.String urlSpec)

Set the URL spec

Parameters:

urlSpec - The URL spec

getDatabaseAdaptor

public DatabaseAdaptor getDatabaseAdaptor()

Get the database adaptor to use

Returns:

the database adaptor

setDatabaseAdaptorClass

public void setDatabaseAdaptorClass(java.lang.Class<?> databaseAdaptorClass)

Set the database adaptor class

Parameters:

databaseAdaptorClass - the database adaptor class to use

setDatabaseAdaptorClass

public void setDatabaseAdaptorClass(java.lang.String className)

Set the database adaptor class

Parameters:

className - the database adaptor class name to use