org.deventropy.junithelper.derby

Class DerbyResourceConfig

java.lang.Object

org.deventropy.junithelper.derby.DerbyResourceConfig

public class DerbyResourceConfig
extends Object

Configurations to control the EmbeddedDerbyResource.

This class provides a fluid interface to build the config object to pass to the constructor of the resource. Example usage:

 EmbeddedDerbyResource derbyResource = new EmbeddedDerbyResource(
                DerbyResourceConfig.buildDefault().);
 

Some methods in this class, for example the methods setting the subSubProtocol, can be mutually exclusive and unset / alter values set by other methods. Certain configuration values have valid values as null and do not have corresponding getDefaultXXX methods.

Author:

Bindul Bhowmik

Constructor Summary

Constructors

Constructor and Description
DerbyResourceConfig()

Method Summary

Modifier and Type	Method and Description
DerbyResourceConfig	addPostInitScript(String postInitScript) Adds a post init script to the config.
static DerbyResourceConfig	buildDefault() Sets up a default config that can be used as is to start a database.
DerbyResourceConfig	createDatabaseFrom(File dbBackupDir) Create a new database from a backup copy.
String	getDatabasePath() Returns the name/path of the database to use.
File	getDbCreateFromRestoreFrom() The location of the database backup to use.
DbCreateFromRestroreMode	getDbCreateFromRestoreMode() Controls if the database should be created or restored from a backup.
File	getDbRecoveryLogDevice() Archive log location for roll-forward database recovery.
static String	getDefaultDatabasePathName() Returns the default database name value, which is a UUID string.
static ErrorLoggingMode	getDefaultErrorLoggingMode() The default logging setup.
static JdbcDerbySubSubProtocol	getDefaultSubSubProtocol() The default sub-sub protocol value.
ErrorLoggingMode	getErrorLoggingMode() The configured error logging mode.
String	getJarDatabaseJarFile() Returns the Jar database jar file path.
List<String>	getPostInitScripts() Gets the configured post init scripts in the config; or an empty list.
JdbcDerbySubSubProtocol	getSubSubProtocol() The JDBC sub-sub protocol to use for the embedded database.
boolean	isDirectoryDatabaseSkipCreate() For a database using the JdbcDerbySubSubProtocol.Directory subsubprotocol, skip the create=true attribute.
DerbyResourceConfig	recoverDatabaseFrom(File dbBackupDir, File recoveryLogDevice) Restore a database with roll forward recovery, optionally with archive logs.
DerbyResourceConfig	restoreDatabaseFrom(File dbBackupDir) Restore a database from a backup location.
DerbyResourceConfig	useClasspathSubSubProtocol(String dbPath) Use the :classpath: Derby sub sub protocol.
DerbyResourceConfig	useDatabaseInDirectory() Use the :directory: Derby sub sub protocol.
DerbyResourceConfig	useDatabaseInDirectory(String directorpyDbPath) Use the :directory: Derby sub sub protocol, with the database in the specified directorpyDbPath.
DerbyResourceConfig	useDatabaseInDirectory(String directorpyDbPath, boolean skipCreateAttribute) Use the :directory: Derby sub sub protocol, with the database in the specified directorpyDbPath.
DerbyResourceConfig	useDefaultErrorLogging() Sets the getErrorLoggingMode() value to ErrorLoggingMode.Default; and clears other logging properties.
DerbyResourceConfig	useDevNullErrorLogging() Sets the getErrorLoggingMode() value to ErrorLoggingMode.Null; and clears other logging properties.
DerbyResourceConfig	useInMemoryDatabase() Will have the database start up as an in-memory database with a database name generated using getDefaultDatabasePathName().
DerbyResourceConfig	useInMemoryDatabase(String databaseName) Will have the database start up as an in-memory database with the specified database name.
DerbyResourceConfig	useJarSubSubProtocol(String jarFilePath, String dbPath) Use the :jar: Derby sub sub protocol.

Methods inherited from class java.lang.Object

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

Constructor Detail

DerbyResourceConfig

public DerbyResourceConfig()

Method Detail

buildDefault

public static DerbyResourceConfig buildDefault()

Sets up a default config that can be used as is to start a database. See the appropriate getDefaultXXX methods to see the default values.

Returns:

A config setup with defaults.

getJarDatabaseJarFile

public String getJarDatabaseJarFile()

Returns the Jar database jar file path. Right now only used for the :jar: protocol for the jar file. Returns the file path of the jar file with the read only database.

Returns:

The jar file path

See Also:

useJarSubSubProtocol(String, String), Accessing a read-only database in a zip/jar file

getDatabasePath

public String getDatabasePath()

Returns the name/path of the database to use. This is a multi purpose field; it is used as the end of the JDBC URL.

• For a memory database, it is the database name;
• For a directory, it is the absolute / relative directory path;
• For a jar database, it is the path of the database inside the jar file;

Consult the documentation for Derby Sub Sub Protocols on database name formats and use.

Returns:

The database name.

See Also:

getDefaultDatabasePathName(), Syntax of db connection URLs

isDirectoryDatabaseSkipCreate

public boolean isDirectoryDatabaseSkipCreate()

For a database using the JdbcDerbySubSubProtocol.Directory subsubprotocol, skip the create=true attribute.

Returns:

the directoryDatabaseSkipCreate

getDefaultDatabasePathName

public static String getDefaultDatabasePathName()

Returns the default database name value, which is a UUID string.

Returns:

The default database name.

useInMemoryDatabase

public DerbyResourceConfig useInMemoryDatabase()

Will have the database start up as an in-memory database with a database name generated using getDefaultDatabasePathName().

Returns:

This instance

useInMemoryDatabase

public DerbyResourceConfig useInMemoryDatabase(String databaseName)

Will have the database start up as an in-memory database with the specified database name.

Parameters:

databaseName - The name of the database

Returns:

This instance

useDatabaseInDirectory

public DerbyResourceConfig useDatabaseInDirectory()

Use the :directory: Derby sub sub protocol. The database will be created in a directory named with the getDefaultDatabasePathName() as the directory name.

Returns:

This instance

useDatabaseInDirectory

public DerbyResourceConfig useDatabaseInDirectory(String directorpyDbPath)

Use the :directory: Derby sub sub protocol, with the database in the specified directorpyDbPath. The path is either relative or absolute as interpreted by the Derby engine.

Parameters:

directorpyDbPath - The relative or absolute path where the database is created.

Returns:

This instance

useDatabaseInDirectory

public DerbyResourceConfig useDatabaseInDirectory(String directorpyDbPath,
                                                  boolean skipCreateAttribute)

Use the :directory: Derby sub sub protocol, with the database in the specified directorpyDbPath. The path is either relative or absolute as interpreted by the Derby engine. If the skipCreateAttribute attribute is set to true, the Database will be initialized without the create=true attribute.

Parameters:

directorpyDbPath - The relative or absolute path where the database is created.

skipCreateAttribute - Skip the create=true attribute in the connection URL

Returns:

This instance

useJarSubSubProtocol

public DerbyResourceConfig useJarSubSubProtocol(String jarFilePath,
                                                String dbPath)

Use the :jar: Derby sub sub protocol. The jar file containing the read only database is a relative or absolute path in jarFilePath and the database path in the dbPath parameter. The jarFilePath is either relative or absolute as interpreted by the Derby engine.

For more format information see Accessing a read-only database in a zip/jar file and Accessing databases from a jar or zip file in the Derby Developer's guide.

Parameters:

jarFilePath - The relative or absolute path where the jar file with the read-only database.

dbPath - The path of the database inside the jar file.

Returns:

This instance

useClasspathSubSubProtocol

public DerbyResourceConfig useClasspathSubSubProtocol(String dbPath)

Use the :classpath: Derby sub sub protocol. This allows access to a read only database in the classpath (see Derby documentation on Accessing databases from the classpath). The database can be either in a Jar file or directly in the classpath.

The dbPath parameter designates the path to the database in the classpath. All databaseNames must begin with at least a slash, because you specify them "relative" to the classpath directory or archive. See also Syntax of database connection URLs for applications with embedded databases and Accessing databases within a jar file using the classpath.

Parameters:

dbPath - The path of the database in the classpath

Returns:

This instance

getSubSubProtocol

public JdbcDerbySubSubProtocol getSubSubProtocol()

The JDBC sub-sub protocol to use for the embedded database.

Returns:

A valid Derby sub-sub protocol

getDefaultSubSubProtocol

public static JdbcDerbySubSubProtocol getDefaultSubSubProtocol()

The default sub-sub protocol value.

Returns:

JdbcDerbySubSubProtocol.Memory

getDbCreateFromRestoreMode

public DbCreateFromRestroreMode getDbCreateFromRestoreMode()

Controls if the database should be created or restored from a backup. A null value returned from this method means no restore. If this is not null, the location of the backup database is returned from getDbCreateFromRestoreFrom(); and for roll-forward recovery, the log device is at getDbRecoveryLogDevice().

See the Backing up and restoring a database section of the Derby Administration guide for more information on means to backup and restore a database.

Returns:

The mode to create / restore a database from a backup.

See Also:

EmbeddedDerbyResource.backupLiveDatabase(File, boolean, boolean, boolean)

getDbCreateFromRestoreFrom

public File getDbCreateFromRestoreFrom()

The location of the database backup to use. This is usually a full backup of the database.

Returns:

The database backup location.

See Also:

getDbCreateFromRestoreMode()

getDbRecoveryLogDevice

public File getDbRecoveryLogDevice()

Archive log location for roll-forward database recovery. See Roll-forward recovery in the Derby administration guide to learn more about archive logging.

Returns:

The Database directory from which archive logs are available.

restoreDatabaseFrom

public DerbyResourceConfig restoreDatabaseFrom(File dbBackupDir)

Restore a database from a backup location. If a database with the same name exists, the system will delete the database, copy it from the backup and restart it.

Parameters:

dbBackupDir - The backup location.

Returns:

This instance.

createDatabaseFrom

public DerbyResourceConfig createDatabaseFrom(File dbBackupDir)

Create a new database from a backup copy. If there is already a database with the same name in derby.system.home, an error will occur and the existing database will be left intact.

Parameters:

dbBackupDir - The location of the database backup.

Returns:

This instance.

recoverDatabaseFrom

public DerbyResourceConfig recoverDatabaseFrom(File dbBackupDir,
                                               File recoveryLogDevice)

Restore a database with roll forward recovery, optionally with archive logs. To see the steps involved in performing a roll forward recovery, see Roll Forward Recovery in the Derby Administrative Guide.

Parameters:

dbBackupDir - The database backup location.

recoveryLogDevice - The archive log location.

Returns:

This instance.

useDevNullErrorLogging

public DerbyResourceConfig useDevNullErrorLogging()

Sets the getErrorLoggingMode() value to ErrorLoggingMode.Null; and clears other logging properties.

Returns:

This instance

useDefaultErrorLogging

public DerbyResourceConfig useDefaultErrorLogging()

Sets the getErrorLoggingMode() value to ErrorLoggingMode.Default; and clears other logging properties.

Returns:

This instance

getErrorLoggingMode

public ErrorLoggingMode getErrorLoggingMode()

The configured error logging mode.

Returns:

the configured error logging mode

getDefaultErrorLoggingMode

public static ErrorLoggingMode getDefaultErrorLoggingMode()

The default logging setup.

Returns:

ErrorLoggingMode.Default

getPostInitScripts

public List<String> getPostInitScripts()

Gets the configured post init scripts in the config; or an empty list.

Returns:

Post init scripts to execute

addPostInitScript

public DerbyResourceConfig addPostInitScript(String postInitScript)

Adds a post init script to the config.

A post init script should refer to a file containing SQL DDL or DML statements that will be executed against the new derby instance. Script locations can be on the classpath or file system or on a HTTP(s) location, for format, see UrlResourceUtil.

Parameters:

postInitScript - A post init script to add

Returns:

this object