TestH2DataSource (mats3 0.19.9-2023-05-04 API)

java.lang.Object
- io.mats3.test.TestH2DataSource

All Implemented Interfaces:

java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource, javax.sql.XADataSource
```
public class TestH2DataSource
extends java.lang.Object
implements javax.sql.XADataSource, javax.sql.DataSource, javax.sql.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 and Description

static class TestH2DataSource.TestH2DataSourceException
A RuntimeException for use in database access methods and tests.

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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FILE_BASED_TEST_H2_DATABASE_URL`
`static java.lang.String`	`IN_MEMORY_TEST_H2_DATABASE_URL`
`static java.lang.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 java.lang.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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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(java.lang.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(java.sql.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.
`java.sql.Connection`	`getConnection()`
`java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password)`
`java.util.List<java.lang.String>`	`getDataFromDataTable()`
`static java.util.List<java.lang.String>`	`getDataFromDataTable(java.sql.Connection sqlConnection)`
`java.lang.String`	`getDescription()` Get the current description.
`int`	`getLoginTimeout()`
`java.io.PrintWriter`	`getLogWriter()`
`java.util.logging.Logger`	`getParentLogger()`
`java.lang.String`	`getPassword()` Get the current password.
`javax.sql.PooledConnection`	`getPooledConnection()`
`javax.sql.PooledConnection`	`getPooledConnection(java.lang.String user, java.lang.String password)`
`java.lang.String`	`getUrl()` Get the current URL.
`java.lang.String`	`getURL()` Get the current URL.
`java.lang.String`	`getUser()` Get the current user name.
`javax.sql.XAConnection`	`getXAConnection()`
`javax.sql.XAConnection`	`getXAConnection(java.lang.String user, java.lang.String password)`
`static void`	`insertDataIntoDataTable(java.sql.Connection sqlConnection, java.lang.String data)` Inserts the provided 'data' into the SQL Table 'datatable', using the provided SQL Connection.
`void`	`insertDataIntoDataTable(java.lang.String data)` Inserts the provided 'data' into the SQL Table 'datatable', using a SQL Connection from `this` DataSource.
`boolean`	`isWrapperFor(java.lang.Class<?> iface)`
`void`	`setDescription(java.lang.String description)` Set the description.
`void`	`setLoginTimeout(int seconds)`
`void`	`setLogWriter(java.io.PrintWriter out)`
`void`	`setPassword(java.lang.String password)` Set the current password.
`void`	`setPasswordChars(char[] password)` Set the current password in the form of a char array.
`void`	`setUrl(java.lang.String url)` Set the current URL.
`void`	`setURL(java.lang.String url)` Set the current URL.
`void`	`setUser(java.lang.String user)` Set the current user name.
`<T> T`	`unwrap(java.lang.Class<T> iface)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SYSPROP_MATS_TEST_H2
```
public static final java.lang.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 java.lang.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 java.lang.String FILE_BASED_TEST_H2_DATABASE_URL
```
    See Also:
    
    Constant Field Values
  - IN_MEMORY_TEST_H2_DATABASE_URL
```
public static final java.lang.String IN_MEMORY_TEST_H2_DATABASE_URL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - 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(java.lang.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(java.sql.Connection connection)
```
    Creates a test "datatable", runs SQL "CREATE TABLE datatable ( data VARCHAR )", using the provided SQL Connection.
  - insertDataIntoDataTable
```
public void insertDataIntoDataTable(java.lang.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(java.sql.Connection sqlConnection,
                                           java.lang.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 java.util.List<java.lang.String> getDataFromDataTable()
```
    Returns:
    
    all rows in the 'datatable' (probably created by createDataTable(), using a SQL Connection from this DataSource.
  - getDataFromDataTable
```
public static java.util.List<java.lang.String> getDataFromDataTable(java.sql.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 java.lang.String getURL()
```
    Get the current URL.
    
    Returns:
    
    the URL
  - getUrl
```
public java.lang.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(java.lang.String url)
```
    Set the current URL.
    
    Parameters:
    
    url - the new URL
  - setUrl
```
public void setUrl(java.lang.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(java.lang.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 java.lang.String getPassword()
```
    Get the current password.
    
    Returns:
    
    the password
  - getUser
```
public java.lang.String getUser()
```
    Get the current user name.
    
    Returns:
    
    the user name
  - setUser
```
public void setUser(java.lang.String user)
```
    Set the current user name.
    
    Parameters:
    
    user - the new user name
  - getDescription
```
public java.lang.String getDescription()
```
    Get the current description.
    
    Returns:
    
    the description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Set the description.
    
    Parameters:
    
    description - the new description
  - getConnection
```
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
```
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Throws:
    
    java.sql.SQLException
  - getConnection
```
public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException
```
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Throws:
    
    java.sql.SQLException
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException
```
    Specified by:
    
    unwrap in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException
```
    Specified by:
    
    isWrapperFor in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException
  - getPooledConnection
```
public javax.sql.PooledConnection getPooledConnection()
                                               throws java.sql.SQLException
```
    Specified by:
    
    getPooledConnection in interface javax.sql.ConnectionPoolDataSource
    
    Throws:
    
    java.sql.SQLException
  - getPooledConnection
```
public javax.sql.PooledConnection getPooledConnection(java.lang.String user,
                                                      java.lang.String password)
                                               throws java.sql.SQLException
```
    Specified by:
    
    getPooledConnection in interface javax.sql.ConnectionPoolDataSource
    
    Throws:
    
    java.sql.SQLException
  - getXAConnection
```
public javax.sql.XAConnection getXAConnection()
                                       throws java.sql.SQLException
```
    Specified by:
    
    getXAConnection in interface javax.sql.XADataSource
    
    Throws:
    
    java.sql.SQLException
  - getXAConnection
```
public javax.sql.XAConnection getXAConnection(java.lang.String user,
                                              java.lang.String password)
                                       throws java.sql.SQLException
```
    Specified by:
    
    getXAConnection in interface javax.sql.XADataSource
    
    Throws:
    
    java.sql.SQLException
  - getLogWriter
```
public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException
```
    Specified by:
    
    getLogWriter in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - setLogWriter
```
public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException
```
    Specified by:
    
    setLogWriter in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException
```
    Specified by:
    
    setLoginTimeout in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - getLoginTimeout
```
public int getLoginTimeout()
                    throws java.sql.SQLException
```
    Specified by:
    
    getLoginTimeout in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - getParentLogger
```
public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException
```
    Specified by:
    
    getParentLogger in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLFeatureNotSupportedException

Class TestH2DataSource

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSPROP_MATS_TEST_H2

SYSPROP_VALUE_FILE_BASED

FILE_BASED_TEST_H2_DATABASE_URL

IN_MEMORY_TEST_H2_DATABASE_URL

Method Detail

createStandard

createFileBased

createInMemoryRandom

create

cleanDatabase

cleanDatabase

createDataTable

createDataTable

insertDataIntoDataTable

insertDataIntoDataTable

getDataFromDataTable

getDataFromDataTable

close

getURL

getUrl

setURL

setUrl

setPassword

setPasswordChars

getPassword

getUser

setUser

getDescription

setDescription

getConnection

getConnection

unwrap

isWrapperFor

getPooledConnection

getPooledConnection

getXAConnection

getXAConnection

getLogWriter

setLogWriter

setLoginTimeout

getLoginTimeout

getParentLogger