com.lf.commons.db.javadb

Class JavaDBEmbeddedHandler

java.lang.Object

com.lf.commons.db.javadb.JavaDBEmbeddedHandler

All Implemented Interfaces:

EmbeddedHandler

public class JavaDBEmbeddedHandler
extends java.lang.Object
implements EmbeddedHandler

Configures and manages the Java DB (aka Apache Derby) database management system.

Unlike most other database systems the Java DB may be directly embedded into running applications instead of creating connections over the network. This class wraps the embedded driver for Java DB whwre the database managament system co-exists within the same JVM as the application.

For simplicity this handler is configured just like the underlying connector via parameters.

Since:

1.6

Version:

$Revision: 1.6 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Properties	params The collection of parameters to use for the database.
protected boolean	running Embedded database is currently running?

Constructor Summary

Constructors

Constructor and Description
JavaDBEmbeddedHandler() Constructor method for i18n purposes only.
JavaDBEmbeddedHandler(java.util.Properties params) Constructor to create a connector instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	changePassword(java.lang.String user, java.lang.String password) Changes the user password.
boolean	flushEmbedded() Flushes the embedded database.
boolean	freezeEmbedded() Freezes the embedded database.
java.lang.String	getAdminConnectionURL() Creates a JDBC connection URL to access the database with admin permissions.
java.lang.String	getEmbeddedType() Provides the FQN class name of the represented connector class.
boolean	isEmbeddedRunning() Is the database management system currently running?
boolean	startEmbedded() Starts the embedded database.
boolean	stopEmbedded() Stops the embedded database.
boolean	unfreezeEmbedded() Unfreezes the embedded database.

Methods inherited from class java.lang.Object

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

Field Detail

params

protected java.util.Properties params

The collection of parameters to use for the database.

running

protected boolean running

Embedded database is currently running?

Constructor Detail

JavaDBEmbeddedHandler

public JavaDBEmbeddedHandler()
                      throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

JavaDBEmbeddedHandler

public JavaDBEmbeddedHandler(java.util.Properties params)

Constructor to create a connector instance.

• PARAM_DB_NAME: required
• PARAM_DB_ADMIN: required
• PARAM_DB_ADMIN_PASSWORD: required
• PARAM_DB_USER: required
• PARAM_DB_USER_PASSWORD: required

Parameters:

params - The database configuration

Throws:

java.lang.NullPointerException - If parameters are invalid

java.lang.IllegalArgumentException - If parameters are invalid

Since:

1.6

Method Detail

getEmbeddedType

public java.lang.String getEmbeddedType()

Provides the FQN class name of the represented connector class.

Specified by:

getEmbeddedType in interface EmbeddedHandler

Returns:

Connector class name

Since:

1.6

isEmbeddedRunning

public boolean isEmbeddedRunning()

Is the database management system currently running?

Specified by:

isEmbeddedRunning in interface EmbeddedHandler

Returns:

Database currently running?

Since:

1.6

startEmbedded

public boolean startEmbedded()

Starts the embedded database.

Specified by:

startEmbedded in interface EmbeddedHandler

Returns:

Database successfully started?

Since:

1.6

stopEmbedded

public boolean stopEmbedded()

Stops the embedded database.

Specified by:

stopEmbedded in interface EmbeddedHandler

Returns:

Database successfully stopped?

Since:

1.6

flushEmbedded

public boolean flushEmbedded()

Flushes the embedded database.

Specified by:

flushEmbedded in interface EmbeddedHandler

Returns:

Database successfully flushed?

Since:

1.6

freezeEmbedded

public boolean freezeEmbedded()

Freezes the embedded database.

Specified by:

freezeEmbedded in interface EmbeddedHandler

Returns:

Database successfully freezed?

Since:

1.6

unfreezeEmbedded

public boolean unfreezeEmbedded()

Unfreezes the embedded database.

Specified by:

unfreezeEmbedded in interface EmbeddedHandler

Returns:

Database successfully unfreezed?

Since:

1.6

changePassword

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

Changes the user password.

Specified by:

changePassword in interface EmbeddedHandler

Parameters:

user - The database user

password - The new password

Returns:

Change was successful?

Since:

1.6

getAdminConnectionURL

public java.lang.String getAdminConnectionURL()

Creates a JDBC connection URL to access the database with admin permissions.

Returns:

The JDBC URL

Since:

1.6