Package de.softwareforge.testing.postgres.embedded

Class DatabaseManager

java.lang.Object

de.softwareforge.testing.postgres.embedded.DatabaseManager

All Implemented Interfaces:

AutoCloseable

public final class DatabaseManager
extends Object
implements AutoCloseable

Controls database instances on a PostgreSQL server instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatabaseManager.Builder<T>	Builder template.
static final class	DatabaseManager.DatabaseManagerBuilder	Create new DatabaseManager instances.

Method Summary

Modifier and Type	Method	Description
void	close()
DatabaseInfo	getDatabaseInfo()	Returns a DatabaseInfo instance that describes a database.
EmbeddedPostgres	getEmbeddedPostgres()	Return the EmbeddedPostgres instance that manages the database server which holds all of the databases managed by this database manager.
static DatabaseManager.Builder<DatabaseManager>	multiDatabases()	Creates a new DatabaseManager.Builder<DatabaseManager> instance that will create a new database on each call to getDatabaseInfo().
static DatabaseManager.Builder<DatabaseManager>	singleDatabase()	Creates a new DatabaseManager.Builder<DatabaseManager> instance that will return a connection to the same database on each call to getDatabaseInfo().
DatabaseManager	start()	Start the database server and the machinery that will provide new database instances.

Methods inherited from class java.lang.Object

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

Method Details

multiDatabases

@Nonnull
public static DatabaseManager.Builder<DatabaseManager> multiDatabases()

Creates a new DatabaseManager.Builder<DatabaseManager> instance that will create a new database on each call to getDatabaseInfo().

Returns:

A builder instance.

singleDatabase

@Nonnull
public static DatabaseManager.Builder<DatabaseManager> singleDatabase()

Creates a new DatabaseManager.Builder<DatabaseManager> instance that will return a connection to the same database on each call to getDatabaseInfo().

Returns:

A builder instance.

start

@Nonnull
public DatabaseManager start()
                      throws IOException,
SQLException

Start the database server and the machinery that will provide new database instances.

Returns:

This object.

Throws:

IOException - The server could not be started.

SQLException - A SQL problem occured while trying to initialize the database.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

getDatabaseInfo

@Nonnull
public DatabaseInfo getDatabaseInfo()
                             throws SQLException

Returns a DatabaseInfo instance that describes a database. If this database provider is in multi mode, every call to this method will return a new database instance. If it is in single mode, it will always return the same database instance.

Returns:

A DatabaseInfo instance. This is never null.

Throws:

SQLException - Any error that happened during the database creation is thrown here.

getEmbeddedPostgres

@Nonnull
public EmbeddedPostgres getEmbeddedPostgres()

Return the EmbeddedPostgres instance that manages the database server which holds all of the databases managed by this database manager.

Returns:

An EmbeddedPostgres instance. Never null.