weave.config

Class ConnectionConfig

java.lang.Object

weave.config.ConnectionConfig

public class ConnectionConfig
extends java.lang.Object

An interface to retrieve strings from a configuration file.

Author:

Andy Dufilie

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionConfig.ConnectionInfo This class contains all the information needed to connect to a SQL database.
static class	ConnectionConfig.DatabaseConfigInfo This class contains all the information related to where the configuration should be stored in a database.
static class	ConnectionConfig.WeaveAuthenticationException

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.URL	DTD_EMBEDDED
static java.lang.String	DTD_FILENAME
static java.lang.String	SQLITE_DB_FILENAME
static java.lang.String	XML_FILENAME

Constructor Summary

Constructors

Constructor and Description
ConnectionConfig(java.io.File file)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowDataConfigInitialize()
java.sql.Connection	getAdminConnection() This function gets a connection to the database containing the configuration information.
ConnectionConfig.ConnectionInfo	getConnectionInfo(java.lang.String name)
ConnectionConfig.ConnectionInfo	getConnectionInfo(java.lang.String name, java.lang.String dsUser, java.lang.String dsPass)
java.util.Collection<java.lang.String>	getConnectionInfoNames()
ConnectionConfig.DatabaseConfigInfo	getDatabaseConfigInfo()
long	getLastModified() Creates an empty SQLite database file if it doesn't already exist.
DataConfig	initializeNewDataConfig(ProgressManager progress) This function must be called before making any modifications to the config.
boolean	migrationPending()
void	removeConnectionInfo(java.lang.String name)
void	saveConnectionInfo(ConnectionConfig.ConnectionInfo connectionInfo)
void	setDatabaseConfigInfo(ConnectionConfig.DatabaseConfigInfo info)

Methods inherited from class java.lang.Object

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

Field Detail

XML_FILENAME

public static final java.lang.String XML_FILENAME

See Also:

Constant Field Values

DTD_FILENAME

public static final java.lang.String DTD_FILENAME

See Also:

Constant Field Values

SQLITE_DB_FILENAME

public static final java.lang.String SQLITE_DB_FILENAME

See Also:

Constant Field Values

DTD_EMBEDDED

public static final java.net.URL DTD_EMBEDDED

Constructor Detail

ConnectionConfig

public ConnectionConfig(java.io.File file)

Method Detail

getLastModified

public long getLastModified()
                     throws java.rmi.RemoteException

Creates an empty SQLite database file if it doesn't already exist. This is only used if SQLite is the chosen config storage location.

Returns:

A reference to the SQLite database file.

Throws:

java.io.IOException - / private File getSQLiteDatabaseFile() throws IOException { File f = new File(_file.getParent(), SQLITE_DB_FILENAME); f.createNewFile(); return f; }

java.rmi.RemoteException

initializeNewDataConfig

public DataConfig initializeNewDataConfig(ProgressManager progress)
                                   throws java.rmi.RemoteException

This function must be called before making any modifications to the config.

Throws:

java.rmi.RemoteException

allowDataConfigInitialize

public boolean allowDataConfigInitialize()
                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

migrationPending

public boolean migrationPending()
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getAdminConnection

public java.sql.Connection getAdminConnection()
                                       throws java.rmi.RemoteException,
                                              java.sql.SQLException

This function gets a connection to the database containing the configuration information. This function will reuse a previously created Connection if it is still valid.

Returns:

A Connection to the SQL database.

Throws:

java.rmi.RemoteException

java.sql.SQLException

getConnectionInfo

public ConnectionConfig.ConnectionInfo getConnectionInfo(java.lang.String name)
                                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getConnectionInfo

public ConnectionConfig.ConnectionInfo getConnectionInfo(java.lang.String name,
                                                java.lang.String dsUser,
                                                java.lang.String dsPass)
                                                  throws java.rmi.RemoteException,
                                                         ConnectionConfig.WeaveAuthenticationException

Throws:

java.rmi.RemoteException

ConnectionConfig.WeaveAuthenticationException

saveConnectionInfo

public void saveConnectionInfo(ConnectionConfig.ConnectionInfo connectionInfo)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

removeConnectionInfo

public void removeConnectionInfo(java.lang.String name)
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getConnectionInfoNames

public java.util.Collection<java.lang.String> getConnectionInfoNames()
                                                              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getDatabaseConfigInfo

public ConnectionConfig.DatabaseConfigInfo getDatabaseConfigInfo()
                                                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setDatabaseConfigInfo

public void setDatabaseConfigInfo(ConnectionConfig.DatabaseConfigInfo info)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException