Package io.mats3.test

Class TestH2DataSource

java.lang.Object

io.mats3.test.TestH2DataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, ConnectionPoolDataSource, DataSource, XADataSource

public class TestH2DataSource
extends Object
implements XADataSource, DataSource, ConnectionPoolDataSource

A wrapped H2 DataBase DataSource which has a couple of extra methods which simplifies testing, in particular the cleanDatabase(), and createDataTable() method with associated convenience methods for storing and getting simple values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestH2DataSource.TestH2DataSourceException	A RuntimeException for use in database access methods and tests.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_BASED_TEST_H2_DATABASE_URL
static final String	IN_MEMORY_TEST_H2_DATABASE_URL
static final String	SYSPROP_MATS_TEST_H2	System property ("-D" jvm argument) that if set will change the method createStandard() from returning an in-memory H2 DataSource, to instead return a DataSource using the URL from the value, with the special case that if the value is "file", it will be "jdbc:h2:./matsTestH2DB;AUTO_SERVER=TRUE".
static final String	SYSPROP_VALUE_FILE_BASED	If the value of SYSPROP_MATS_TEST_H2 is this value, the createStandard() will use the URL FILE_BASED_TEST_H2_DATABASE_URL, which is "jdbc:h2:./matsTestH2DB;AUTO_SERVER=TRUE".

Method Summary

Modifier and Type	Method	Description
void	cleanDatabase()	Cleans the test database: Runs SQL "DROP ALL OBJECTS DELETE FILES".
void	cleanDatabase(boolean createDataTable)	Cleans the test database: Runs SQL "DROP ALL OBJECTS DELETE FILES", and optionally invokes createDataTable().
void	close()	Closes the database IF it is a random in-memory URL (as created by createInMemoryRandom(), note: this method will be picked up by Spring as a destroy-method if the instance is made available as a Bean.
static TestH2DataSource	create(String url)	Creates a TestH2DataSource using the supplied URL.
void	createDataTable()	Creates a test "datatable", runs SQL "CREATE TABLE datatable ( data VARCHAR )", using a SQL Connection from this DataSource.
static void	createDataTable(Connection connection)	Creates a test "datatable", runs SQL "CREATE TABLE datatable ( data VARCHAR )", using the provided SQL Connection.
static TestH2DataSource	createFileBased()	Creates a TestH2DataSource using the URL FILE_BASED_TEST_H2_DATABASE_URL, which is "jdbc:h2:./matsTestH2DB;AUTO_SERVER=TRUE".
static TestH2DataSource	createInMemoryRandom()	Creates a unique (random) TestH2DataSource using the URL IN_MEMORY_TEST_H2_DATABASE_URL, which is "jdbc:h2:mem:matsTestH2DB_[randomness];DB_CLOSE_DELAY=-1".
static TestH2DataSource	createStandard()	Creates an in-memory TestH2DataSource as specified by the URL IN_MEMORY_TEST_H2_DATABASE_URL, which is "jdbc:h2:mem:matsTestH2DB_[randomness];DB_CLOSE_DELAY=-1", unless the System Property SYSPROP_MATS_TEST_H2 ("mats.test.h2") is directly set to a different URL to use, with the special case that if it is SYSPROP_VALUE_FILE_BASED ("file"), in which case FILE_BASED_TEST_H2_DATABASE_URL ("jdbc:h2:./matsTestH2DB;AUTO_SERVER=TRUE) is used as URL.
Connection	getConnection()
Connection	getConnection(String username, String password)
List<String>	getDataFromDataTable()
static List<String>	getDataFromDataTable(Connection sqlConnection)
String	getDescription()	Get the current description.
int	getLoginTimeout()
PrintWriter	getLogWriter()
Logger	getParentLogger()
String	getPassword()	Get the current password.
PooledConnection	getPooledConnection()
PooledConnection	getPooledConnection(String user, String password)
String	getUrl()	Get the current URL.
String	getURL()	Get the current URL.
String	getUser()	Get the current user name.
XAConnection	getXAConnection()
XAConnection	getXAConnection(String user, String password)
void	insertDataIntoDataTable(String data)	Inserts the provided 'data' into the SQL Table 'datatable', using a SQL Connection from this DataSource.
static void	insertDataIntoDataTable(Connection sqlConnection, String data)	Inserts the provided 'data' into the SQL Table 'datatable', using the provided SQL Connection.
boolean	isWrapperFor(Class<?> iface)
void	setDescription(String description)	Set the description.
void	setLoginTimeout(int seconds)
void	setLogWriter(PrintWriter out)
void	setPassword(String password)	Set the current password.
void	setPasswordChars(char[] password)	Set the current password in the form of a char array.
void	setUrl(String url)	Set the current URL.
void	setURL(String url)	Set the current URL.
void	setUser(String user)	Set the current user name.
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder

Methods inherited from interface javax.sql.ConnectionPoolDataSource

createPooledConnectionBuilder

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder

Methods inherited from interface javax.sql.XADataSource

createXAConnectionBuilder

Field Details

SYSPROP_MATS_TEST_H2

public static final String SYSPROP_MATS_TEST_H2

System property ("-D" jvm argument) that if set will change the method createStandard() from returning an in-memory H2 DataSource, to instead return a DataSource using the URL from the value, with the special case that if the value is "file", it will be "jdbc:h2:./matsTestH2DB;AUTO_SERVER=TRUE".

Value is "mats.test.activemq"

See Also:

• Constant Field Values

SYSPROP_VALUE_FILE_BASED

public static final String SYSPROP_VALUE_FILE_BASED

If the value of SYSPROP_MATS_TEST_H2 is this value, the createStandard() will use the URL FILE_BASED_TEST_H2_DATABASE_URL, which is "jdbc:h2:./matsTestH2DB;AUTO_SERVER=TRUE".

Value is "file"

See Also:

• Constant Field Values

FILE_BASED_TEST_H2_DATABASE_URL

public static final String FILE_BASED_TEST_H2_DATABASE_URL

See Also:

• Constant Field Values

IN_MEMORY_TEST_H2_DATABASE_URL

public static final String IN_MEMORY_TEST_H2_DATABASE_URL

See Also:

• Constant Field Values

Method Details

createStandard

public static TestH2DataSource createStandard()

Creates an in-memory TestH2DataSource as specified by the URL IN_MEMORY_TEST_H2_DATABASE_URL, which is "jdbc:h2:mem:matsTestH2DB_[randomness];DB_CLOSE_DELAY=-1", unless the System Property SYSPROP_MATS_TEST_H2 ("mats.test.h2") is directly set to a different URL to use, with the special case that if it is SYSPROP_VALUE_FILE_BASED ("file"), in which case FILE_BASED_TEST_H2_DATABASE_URL ("jdbc:h2:./matsTestH2DB;AUTO_SERVER=TRUE) is used as URL.

Notice that the method cleanDatabase() is invoked when creating the DataSource, which is relevant when using the file-based variant.

Returns:

the created TestH2DataSource.

createFileBased

public static TestH2DataSource createFileBased()

Creates a TestH2DataSource using the URL FILE_BASED_TEST_H2_DATABASE_URL, which is "jdbc:h2:./matsTestH2DB;AUTO_SERVER=TRUE".

Returns:

the created TestH2DataSource.

createInMemoryRandom

public static TestH2DataSource createInMemoryRandom()

Creates a unique (random) TestH2DataSource using the URL IN_MEMORY_TEST_H2_DATABASE_URL, which is "jdbc:h2:mem:matsTestH2DB_[randomness];DB_CLOSE_DELAY=-1".

Returns:

the created TestH2DataSource.

create

public static TestH2DataSource create(String url)

Creates a TestH2DataSource using the supplied URL.

Returns:

the created TestH2DataSource.

cleanDatabase

public void cleanDatabase()

Cleans the test database: Runs SQL "DROP ALL OBJECTS DELETE FILES".

cleanDatabase

public void cleanDatabase(boolean createDataTable)

Cleans the test database: Runs SQL "DROP ALL OBJECTS DELETE FILES", and optionally invokes createDataTable().

Parameters:

createDataTable - whether to invoke createDataTable() afterwards.

createDataTable

public void createDataTable()

Creates a test "datatable", runs SQL "CREATE TABLE datatable ( data VARCHAR )", using a SQL Connection from this DataSource.

createDataTable

public static void createDataTable(Connection connection)

Creates a test "datatable", runs SQL "CREATE TABLE datatable ( data VARCHAR )", using the provided SQL Connection.

insertDataIntoDataTable

public void insertDataIntoDataTable(String data)

Inserts the provided 'data' into the SQL Table 'datatable', using a SQL Connection from this DataSource.

Parameters:

data - the data to insert.

insertDataIntoDataTable

public static void insertDataIntoDataTable(Connection sqlConnection,
 String data)

Inserts the provided 'data' into the SQL Table 'datatable', using the provided SQL Connection.

Parameters:

sqlConnection - the SQL Connection to use to insert data.

data - the data to insert.

getDataFromDataTable

public List<String> getDataFromDataTable()

Returns:

all rows in the 'datatable' (probably created by createDataTable(), using a SQL Connection from this DataSource.

getDataFromDataTable

public static List<String> getDataFromDataTable(Connection sqlConnection)

Parameters:

sqlConnection - the SQL Connection to use to fetch data.

Returns:

all rows in the 'datatable' (probably created by createDataTable(), using the provided SQL Connection - the SQL is "SELECT data FROM datatable ORDER BY data".

close

public void close()

Closes the database IF it is a random in-memory URL (as created by createInMemoryRandom(), note: this method will be picked up by Spring as a destroy-method if the instance is made available as a Bean.

getURL

public String getURL()

Get the current URL.

Returns:

the URL

getUrl

public String getUrl()

Get the current URL. This method does the same as getURL, but this methods signature conforms the JavaBean naming convention.

Returns:

the URL

setURL

public void setURL(String url)

Set the current URL.

Parameters:

url - the new URL

setUrl

public void setUrl(String url)

Set the current URL. This method does the same as setURL, but this methods signature conforms the JavaBean naming convention.

Parameters:

url - the new URL

setPassword

public void setPassword(String password)

Set the current password.

Parameters:

password - the new password.

setPasswordChars

public void setPasswordChars(char[] password)

Set the current password in the form of a char array.

Parameters:

password - the new password in the form of a char array.

getPassword

public String getPassword()

Get the current password.

Returns:

the password

getUser

public String getUser()

Get the current user name.

Returns:

the user name

setUser

public void setUser(String user)

Set the current user name.

Parameters:

user - the new user name

getDescription

public String getDescription()

Get the current description.

Returns:

the description

setDescription

public void setDescription(String description)

Set the description.

Parameters:

description - the new description

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String username,
 String password)
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

getPooledConnection

public PooledConnection getPooledConnection()
                                     throws SQLException

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Throws:

SQLException

getPooledConnection

public PooledConnection getPooledConnection(String user,
 String password)
                                     throws SQLException

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Throws:

SQLException

getXAConnection

public XAConnection getXAConnection()
                             throws SQLException

Specified by:

getXAConnection in interface XADataSource

Throws:

SQLException

getXAConnection

public XAConnection getXAConnection(String user,
 String password)
                             throws SQLException

Specified by:

getXAConnection in interface XADataSource

Throws:

SQLException

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

Specified by:

getLogWriter in interface CommonDataSource

Specified by:

getLogWriter in interface ConnectionPoolDataSource

Specified by:

getLogWriter in interface DataSource

Specified by:

getLogWriter in interface XADataSource

Throws:

SQLException

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

Specified by:

setLogWriter in interface CommonDataSource

Specified by:

setLogWriter in interface ConnectionPoolDataSource

Specified by:

setLogWriter in interface DataSource

Specified by:

setLogWriter in interface XADataSource

Throws:

SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

Specified by:

setLoginTimeout in interface CommonDataSource

Specified by:

setLoginTimeout in interface ConnectionPoolDataSource

Specified by:

setLoginTimeout in interface DataSource

Specified by:

setLoginTimeout in interface XADataSource

Throws:

SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

Specified by:

getLoginTimeout in interface CommonDataSource

Specified by:

getLoginTimeout in interface ConnectionPoolDataSource

Specified by:

getLoginTimeout in interface DataSource

Specified by:

getLoginTimeout in interface XADataSource

Throws:

SQLException

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface CommonDataSource

Throws:

SQLFeatureNotSupportedException