com.lf.commons.db

Class SimpleDatabaseManager

java.lang.Object

com.lf.commons.db.DatabaseManager

com.lf.commons.db.SimpleDatabaseManager

public class SimpleDatabaseManager
extends DatabaseManager

Simple database manager implementation with straight connector support and no update capability.

Useful for test classes that need only one specific driver to be set up.

Since:

1.6

Version:

$Revision: 1.6 $, $Date: 2011/07/31 15:28:13 $

Author:

Axel Schwolow

Field Summary

Fields inherited from class com.lf.commons.db.DatabaseManager

backupSchemas, cacheConnectionByID, cacheConnectorByConnectionID, cacheConnectorByConnectorID, cacheConnectorDefByType, cacheEmbeddedByType, counterConnectorID, inspectedSchemas

Constructor Summary

Constructors

Constructor and Description
SimpleDatabaseManager() Constructor method for the manager.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	changePassword(java.lang.String type, java.lang.String user, java.lang.String password) Changes the user password for the given embedded database.
boolean	connect(DatabaseConnector connector, boolean updatecheck) Connects to the configured database.
java.sql.Connection	createNewConnection(DatabaseConnector connector, java.lang.String jdbcurl) Lets the given connector create a new connection for the given JDBC URL.
DatabaseTabbedSession	createNewSession(DatabaseConnection dbconn, boolean connect) Convenience method to create a new session.
boolean	disconnect(DatabaseConnector connector) Disconnects from the configured database.
boolean	flushEmbedded(java.lang.String type) Flushes the given embedded database.
boolean	freezeEmbedded(java.lang.String type) Freezes the given embedded database.
java.lang.String	getDefaultConnectionURL(DatabaseConnector connector) Provides the JDBC URL for the default connection (normally a user connection).
boolean	isEmbeddedRunning(java.lang.String type) Is the embedded database management system currently running?
boolean	isSchemaNewer(java.lang.String versionID1, java.lang.String versionID2) Checks whether the first schema version identifier is newer than the second.
boolean	reset(DatabaseConnector connector) Resets the connector for the configured database.
boolean	startEmbedded(java.lang.String type) Starts the given embedded database.
boolean	stopEmbedded(java.lang.String type) Stops the given embedded database.
boolean	unfreezeEmbedded(java.lang.String type) Unfreezes the given embedded database.
boolean	update(DatabaseConnector connector, SchemaProps schemaprops) Updates the database schema for the given connector.

Methods inherited from class com.lf.commons.db.DatabaseManager

addBackupSchema, addConnection, addConnectorDef, addEmbeddedHandler, addInspectedSchema, createNewConnector, createNextConnectorID, finalize, findConnectors, getAllConnections, getAllConnectorDefs, getAllConnectors, getAllEmbeddedHandlers, getBackupSchemas, getConnection, getConnection, getConnectionName, getConnections, getConnector, getConnectorDef, getConnectorID, getConnectors, getEmbeddedHandler, getFirstBestConnectedConnector, getInspectedSchemas, getUniqueConnectionID, getUsableConnectorDefs, hasConnectorDef, hasEmbeddedHandler, hasUsableConnectorDef, isEmbedded, printDebugConnections, removeAllConnections, removeAllConnectorDefs, removeConnection, removeConnection, removeConnector, removeConnectorDef, removeConnectorDef, removeEmbeddedHandler, updateConnections

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDatabaseManager

public SimpleDatabaseManager()

Constructor method for the manager.

Since:

1.6

Method Detail

getDefaultConnectionURL

public java.lang.String getDefaultConnectionURL(DatabaseConnector connector)

Provides the JDBC URL for the default connection (normally a user connection).

Specified by:

getDefaultConnectionURL in class DatabaseManager

Parameters:

connector - The connector

Returns:

The JDBC URL for the default connection, null if an error occurs

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

connect

public boolean connect(DatabaseConnector connector,
              boolean updatecheck)

Connects to the configured database.

Specified by:

connect in class DatabaseManager

Parameters:

connector - The connector

updatecheck - Update database if necessary

Returns:

Connection established?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

disconnect

public boolean disconnect(DatabaseConnector connector)

Disconnects from the configured database.

Specified by:

disconnect in class DatabaseManager

Parameters:

connector - The connector

Returns:

Successfully disconnected?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

reset

public boolean reset(DatabaseConnector connector)

Resets the connector for the configured database.

Specified by:

reset in class DatabaseManager

Parameters:

connector - The connector

Returns:

Successfully reset?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

createNewConnection

public java.sql.Connection createNewConnection(DatabaseConnector connector,
                                      java.lang.String jdbcurl)

Lets the given connector create a new connection for the given JDBC URL.

Specified by:

createNewConnection in class DatabaseManager

Parameters:

connector - The connector

jdbcurl - The JDBC URL

Returns:

Connection for the database, may be null if an error occurred

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

isSchemaNewer

public boolean isSchemaNewer(java.lang.String versionID1,
                    java.lang.String versionID2)

Checks whether the first schema version identifier is newer than the second.

Specified by:

isSchemaNewer in class DatabaseManager

Parameters:

versionID1 - The first version identifier

versionID2 - The second version identifier

Returns:

First schema version identifier newer than the second?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

update

public boolean update(DatabaseConnector connector,
             SchemaProps schemaprops)

Updates the database schema for the given connector.

Specified by:

update in class DatabaseManager

Parameters:

connector - The connector to use, should be already connected

schemaprops - The schema properties

Returns:

Update successful?

isEmbeddedRunning

public boolean isEmbeddedRunning(java.lang.String type)

Is the embedded database management system currently running?

Specified by:

isEmbeddedRunning in class DatabaseManager

Parameters:

type - The connector class name in FQN

Returns:

Database currently running?

Since:

1.6

startEmbedded

public boolean startEmbedded(java.lang.String type)

Starts the given embedded database.

Specified by:

startEmbedded in class DatabaseManager

Parameters:

type - The connector class name in FQN

Returns:

Database successfully started?

Since:

1.6

stopEmbedded

public boolean stopEmbedded(java.lang.String type)

Stops the given embedded database.

Specified by:

stopEmbedded in class DatabaseManager

Parameters:

type - The connector class name in FQN

Returns:

Database successfully stopped?

Since:

1.6

flushEmbedded

public boolean flushEmbedded(java.lang.String type)

Flushes the given embedded database.

Specified by:

flushEmbedded in class DatabaseManager

Parameters:

type - The connector class name in FQN

Returns:

Database successfully flushed?

Since:

1.6

freezeEmbedded

public boolean freezeEmbedded(java.lang.String type)

Freezes the given embedded database.

Specified by:

freezeEmbedded in class DatabaseManager

Parameters:

type - The connector class name in FQN

Returns:

Database successfully freezed?

Since:

1.6

unfreezeEmbedded

public boolean unfreezeEmbedded(java.lang.String type)

Unfreezes the given embedded database.

Specified by:

unfreezeEmbedded in class DatabaseManager

Parameters:

type - The connector class name in FQN

Returns:

Database successfully unfreezed?

Since:

1.6

changePassword

public boolean changePassword(java.lang.String type,
                     java.lang.String user,
                     java.lang.String password)

Changes the user password for the given embedded database.

Specified by:

changePassword in class DatabaseManager

Parameters:

type - The connector class name in FQN

user - The database user

password - The new password

Returns:

Change was successful?

Since:

1.6

createNewSession

public DatabaseTabbedSession createNewSession(DatabaseConnection dbconn,
                                     boolean connect)

Convenience method to create a new session.

Specified by:

createNewSession in class DatabaseManager

Parameters:

dbconn - The connection to use

connect - Connect to database

Returns:

The new session, may be null

Since:

1.6