A B C D E G I J O P R S U V

A

addPostInitScript(String) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Adds a post init script to the config.

after() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

appendDbLocNameToUrl(StringBuilder) - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Adds the database name to the Derby JDBC Url being built, taking into consideration sub-protocol specific variations.

B

backupLiveDatabase(File, boolean, boolean, boolean) - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Perform an online backup of the running instance.

backupLiveDatabase(File, boolean, boolean, boolean) - Method in class org.deventropy.junithelper.derby.util.DerbyBackupOperationsHelper

Perform an online backup of the running instance.

before() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

buildDefault() - Static method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Sets up a default config that can be used as is to start a database.

C

close() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Shuts down and closes the Derby Instance.

closeQuietly(AutoCloseable) - Static method in class org.deventropy.junithelper.derby.util.DerbyUtils

Quietly close an AutoCloseable resource, like a SQL Connection, Statement, etc.

createConnection() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Create and return a new connection for this resource.

createDatabaseFrom(File) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Create a new database from a backup copy.

D

datasourceDatabaseNamePrefix() - Method in enum org.deventropy.junithelper.derby.JdbcDerbySubSubProtocol

Returns the database name prefix (with the sub-sub protocol) as required to set up a datasource for the database.

DbCreateFromRestroreMode - Enum in org.deventropy.junithelper.derby

When creating or restoring a database from a backup copy, Derby supports one of three modes.

DEFAULT_CHARSET - Static variable in class org.deventropy.junithelper.derby.util.DerbyScriptRunner

Default system character set to use if none is specified by the user.

DERBY_EMBEDDED_DRIVER_CLASS - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Derby embedded JDBC driver class.

DERBY_JDBC_URL_PREFIX - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Derby JDBC URL prefix.

DerbyBackupOperationsHelper - Class in org.deventropy.junithelper.derby.util

Helper class used by the EmbeddedDerbyResource to implement online backup operations on the instance.

DerbyBackupOperationsHelper(EmbeddedDerbyResource) - Constructor for class org.deventropy.junithelper.derby.util.DerbyBackupOperationsHelper

Initializes the backup operations helper with the derby resource.

DerbyConstants - Class in org.deventropy.junithelper.derby

Holds Derby related strings as constants.

DerbyResourceConfig - Class in org.deventropy.junithelper.derby

Configurations to control the EmbeddedDerbyResource.

DerbyResourceConfig() - Constructor for class org.deventropy.junithelper.derby.DerbyResourceConfig

DerbyScriptRunner - Class in org.deventropy.junithelper.derby.util

Executes a SQL script on the given Derby embedded instance connection.

DerbyScriptRunner(Connection, String) - Constructor for class org.deventropy.junithelper.derby.util.DerbyScriptRunner

Initializes a new script runner.

DerbyScriptRunner(Connection) - Constructor for class org.deventropy.junithelper.derby.util.DerbyScriptRunner

Initializes a new script runner for the connection.

DerbyUtils - Class in org.deventropy.junithelper.derby.util

Random utilities for this library and also useful when writing JDBC test cases.

DEV_NULL - Static variable in class org.deventropy.junithelper.derby.util.DerbyUtils

Stream used for DEV_NULL logging.

DEV_NULL_FIELD_ID - Static variable in class org.deventropy.junithelper.derby.util.DerbyUtils

A string ID that may be used to refer to DEV_NULL from property values (used by Derby).

E

EmbeddedDerbyDataSourceFactory - Interface in org.deventropy.junithelper.derby.datasource

Factory for creating DataSource instances to connect to a Derby resource.

EmbeddedDerbyDataSourceResource - Class in org.deventropy.junithelper.derby.datasource

Provides an in-memory Derby resource capable of providing different kinds of DataSources supported by Derby.

EmbeddedDerbyDataSourceResource(DerbyResourceConfig, File) - Constructor for class org.deventropy.junithelper.derby.datasource.EmbeddedDerbyDataSourceResource

Creates a new Derby resource.

EmbeddedDerbyDataSourceResource(DerbyResourceConfig, TemporaryFolder) - Constructor for class org.deventropy.junithelper.derby.datasource.EmbeddedDerbyDataSourceResource

Creates a new Derby resource.

EmbeddedDerbyResource - Class in org.deventropy.junithelper.derby

Provides an in-memory Derby resource.

EmbeddedDerbyResource(DerbyResourceConfig, File) - Constructor for class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Creates a new Derby resource.

EmbeddedDerbyResource(DerbyResourceConfig, TemporaryFolder) - Constructor for class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Creates a new Derby resource.

ensureActive() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Checks if the Embedded Derby Resource is active, if not throws an IllegalStateException.

ErrorLoggingMode - Enum in org.deventropy.junithelper.derby

Derby error logging (derby.log) modes supported by the JUnit Derby helper.

executeScript(String) - Method in class org.deventropy.junithelper.derby.util.DerbyScriptRunner

Executes the given script.

executeScript(String, File) - Method in class org.deventropy.junithelper.derby.util.DerbyScriptRunner

Executes the given script.

executeScript(String, OutputStream, boolean) - Method in class org.deventropy.junithelper.derby.util.DerbyScriptRunner

Executes the given script.

G

getConfig() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Allows extending classes to use the config.

getConnectionPoolDataSource(boolean) - Method in interface org.deventropy.junithelper.derby.datasource.EmbeddedDerbyDataSourceFactory

Returns a new or cached ConnectionPoolDataSource instance with parameters set up to create connections to connect to the underlying Derby instance.

getDatabasePath() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Returns the name/path of the database to use.

getDatabasePath() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Returns the database path of the JDBC URL.

getDataSource(boolean) - Method in interface org.deventropy.junithelper.derby.datasource.EmbeddedDerbyDataSourceFactory

Returns a new or cached DataSource instance with parameters set up to create connections to connect to the underlying Derby instance.

getDataSourceFactory() - Method in class org.deventropy.junithelper.derby.datasource.EmbeddedDerbyDataSourceResource

Returns the EmbeddedDerbyDataSourceFactory instance for this resource from which data sources can be created / cached.

getDbCreateFromRestoreFrom() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

The location of the database backup to use.

getDbCreateFromRestoreMode() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Controls if the database should be created or restored from a backup.

getDbRecoveryLogDevice() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Archive log location for roll-forward database recovery.

getDefaultDatabasePathName() - Static method in class org.deventropy.junithelper.derby.DerbyResourceConfig

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

getDefaultErrorLoggingMode() - Static method in class org.deventropy.junithelper.derby.DerbyResourceConfig

The default logging setup.

getDefaultSubSubProtocol() - Static method in class org.deventropy.junithelper.derby.DerbyResourceConfig

The default sub-sub protocol value.

getDerbySystemHome() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Returns the file reference to the Derby system home.

getErrorLoggingMode() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

The configured error logging mode.

getJarDatabaseJarFile() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Returns the Jar database jar file path.

getJdbcUrl() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Returns a URL that can be used to create a connection to this database instance.

getPostInitScripts() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

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

getSubSubProtocol() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

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

getXADataSource(boolean) - Method in interface org.deventropy.junithelper.derby.datasource.EmbeddedDerbyDataSourceFactory

Returns a new or cached XADataSource instance with parameters set up to create connections to connect to the underlying Derby instance.

I

isActive() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Returns true if the resource is started and not closed.

isDirectoryDatabaseSkipCreate() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

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

J

jdbcConnectionPrefix() - Method in enum org.deventropy.junithelper.derby.JdbcDerbySubSubProtocol

Get the JDBC connection string prefix to construct a JDBC connection string with this sub-protocol.

JdbcDerbySubSubProtocol - Enum in org.deventropy.junithelper.derby

Embedded Derby JDBC Sub-Protocols supported by this tool.

O

org.deventropy.junithelper.derby - package org.deventropy.junithelper.derby

JUnit Helper Derby is a utility to allow testing JDBC related code against Apache Derby embedded instances using JUnit version 4.x.

org.deventropy.junithelper.derby.datasource - package org.deventropy.junithelper.derby.datasource

Junit Helper Derby extensions to support working with DataSources over a EmbeddedDerbyResource using the JUnit 4.x resource EmbeddedDerbyDataSourceResource.

org.deventropy.junithelper.derby.util - package org.deventropy.junithelper.derby.util

Utility classes as part of the Deventropy Junit Helper Derby package.

P

PROP_DERBY_STREAM_ERROR_FIELD - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Static fully qualified field of type OutputStream for error logging.

PROP_DERBY_STREAM_ERROR_FILE - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Error log file location.

PROP_DERBY_SYSTEM_HOME - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Derby System Home location.

PROP_FILE_DERBY_PROPERTIES - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Default Derby properties file.

R

recoverDatabaseFrom(File, File) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Restore a database with roll forward recovery, optionally with archive logs.

requiresLogDevice() - Method in enum org.deventropy.junithelper.derby.DbCreateFromRestroreMode

If the recovery mode requires the archive log recovery.

restoreDatabaseFrom(File) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Restore a database from a backup location.

S

setDefaultScriptLogStream(OutputStream) - Method in class org.deventropy.junithelper.derby.util.DerbyScriptRunner

Sets the log stream to log results to.

shutdownDerbySystemQuitely(boolean) - Static method in class org.deventropy.junithelper.derby.util.DerbyUtils

Shuts down the derby system so it can be reloaded; per Derby developer guide.

start() - Method in class org.deventropy.junithelper.derby.EmbeddedDerbyResource

Starts the Embedded derby instance.

SYSPROC_BACKUP_DB - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Online backup a database.

SYSPROC_BACKUP_DB_ENABLE_LOG_ARCHIVE - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Online backup a database, with archive logging.

SYSPROC_BACKUP_DB_ENABLE_LOG_ARCHIVE_NOWAIT - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Online backup a database with archive logging, don't wait for transactions.

SYSPROC_BACKUP_DB_NOWAIT - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Online backup a database, don't wait for transactions.

U

urlAttribute() - Method in enum org.deventropy.junithelper.derby.DbCreateFromRestroreMode

The attribute key to add to the JDBC connection URL.

URLPROP_DERBY_CREATE - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Create a database.

URLPROP_DERBY_DROP - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Drop a database.

URLPROP_DERBY_EQUAL - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Key / value separator.

URLPROP_DERBY_LOGDEVICE - Static variable in enum org.deventropy.junithelper.derby.DbCreateFromRestroreMode

Log device property.

URLPROP_DERBY_SEPARATOR - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Separator between two properties.

URLPROP_DERBY_SHUTDOWN - Static variable in class org.deventropy.junithelper.derby.DerbyConstants

Shutdown a database.

useClasspathSubSubProtocol(String) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Use the :classpath: Derby sub sub protocol.

useDatabaseInDirectory() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Use the :directory: Derby sub sub protocol.

useDatabaseInDirectory(String) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Use the :directory: Derby sub sub protocol, with the database in the specified directorpyDbPath.

useDatabaseInDirectory(String, boolean) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Use the :directory: Derby sub sub protocol, with the database in the specified directorpyDbPath.

useDefaultErrorLogging() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

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

useDevNullErrorLogging() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

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

useInMemoryDatabase() - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

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

useInMemoryDatabase(String) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

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

useJarSubSubProtocol(String, String) - Method in class org.deventropy.junithelper.derby.DerbyResourceConfig

Use the :jar: Derby sub sub protocol.

V

valueOf(String) - Static method in enum org.deventropy.junithelper.derby.DbCreateFromRestroreMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.deventropy.junithelper.derby.ErrorLoggingMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.deventropy.junithelper.derby.JdbcDerbySubSubProtocol

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.deventropy.junithelper.derby.DbCreateFromRestroreMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.deventropy.junithelper.derby.ErrorLoggingMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.deventropy.junithelper.derby.JdbcDerbySubSubProtocol

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G I J O P R S U V