TestConfiguration (Apache Derby V10.13 Test Javadoc)

java.lang.Object
- org.apache.derbyTesting.junit.TestConfiguration

```
public final class TestConfiguration
extends java.lang.Object
```
Class which holds information about the configuration of a Test. A configuration manages the pool of databases in use in usedDbNames property. One of those databases is supposed to be the default database. A new default database is added to the pool by singleUseDatabaseDecorator function.
Additional databases may be added by additionalDatabaseDecorator function. Each of the additional databases has its logical and physical name. Physical database name is automatically generated as 'singleUse/oneuseXX' where 'XX' is unique number. The logical database name is used to establish a connection to the database using a TestConfiguration::openConnection(String logicalDatabaseName) function.
The database files are supposed to be local and they will be removed by DropDatabaseSetup.

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`assignedPortCount`
`private static int`	`basePort` This is the base port.
`private static int`	`bogusPort`
`private java.util.Properties`	`connectionAttributes` Extra connection attributes.
`(package private) Connector`	`connector` Indirection for obtaining connections based upon this configuration.
`private static java.lang.ThreadLocal<TestConfiguration>`	`CURRENT_CONFIG` Current configuration is stored in a ThreadLocal to allow the potential for multiple tests to be running concurrently with different configurations.
`private static TestConfiguration`	`DEFAULT_CONFIG` The default configuration.
`private static java.lang.String`	`DEFAULT_DBNAME` Default values for configurations
`private static java.lang.String`	`DEFAULT_DBNAME_SQL`
`private static java.lang.String`	`DEFAULT_FRAMEWORK`
`private static java.lang.String`	`DEFAULT_HOSTNAME`
`private static int`	`DEFAULT_PORT`
`private static java.lang.String`	`DEFAULT_USER_NAME`
`private static java.lang.String`	`DEFAULT_USER_PASSWORD`
`private java.lang.String`	`defaultDbName` The default database name for tests.
`private boolean`	`doTrace`
`private java.lang.String`	`hostName`
`private boolean`	`isVerbose`
`private JDBCClient`	`jdbcClient`
`private int`	`jmxPort`
`private static TestConfiguration`	`JUNIT_CONFIG` Default configuration for standalone JUnit tests, an embedded configuration.
`private static java.lang.String`	`KEY_DBNAME` Keys to use to look up values in properties files.
`private static java.lang.String`	`KEY_FRAMEWORK`
`private static java.lang.String`	`KEY_HOSTNAME`
`private static java.lang.String`	`KEY_JMX_PORT`
`private static java.lang.String`	`KEY_LOGIN_TIMEOUT`
`static java.lang.String`	`KEY_OMIT_JSON`
`static java.lang.String`	`KEY_OMIT_LUCENE`
`private static java.lang.String`	`KEY_PORT`
`private static java.lang.String`	`KEY_SSL`
`private static java.lang.String`	`KEY_STOP_AFTER_FIRST_FAIL` derby.tests.stopAfterFirstFail - debugging property to exit after first failure.
`private static java.lang.String`	`KEY_TRACE`
`private static java.lang.String`	`KEY_USER_NAME`
`private static java.lang.String`	`KEY_USER_PASSWORD`
`private static java.lang.String`	`KEY_VERBOSE`
`private static int`	`lastAssignedPort`
`private static int`	`LOCKFILETIMEOUT`
`private java.util.HashMap<java.lang.String,java.lang.String>`	`logicalDbMapping` Contains the mapping of logical database names to physical database names.
`private static int`	`MAX_PORTS_USED` Maximum number of ports used by Suites.All If this changes, this constant and the Wiki page at http://wiki.apache.org/db-derby/DerbyJUnitTesting need to be updated.
`private java.lang.String`	`passwordToken` Password token used by the builtin authentication decorators.
`private int`	`port`
`private static ReleaseRepository`	`releaseRepository` Repository of old/previous Derby releases available on the local system.
`private java.io.FileOutputStream`	`serverOutput`
`private static int`	`SLEEP_TIME` Sleep for 1000 ms before pinging the network server (again)
`private java.lang.String`	`ssl`
`private boolean`	`stopAfterFirstFail`
`private static int`	`uniqueDB` Simple count to provide a unique number for database names.
`private java.lang.String`	`url`
`private java.util.ArrayList<java.lang.String>`	`usedDbNames` Holds the names of all other databases used in a test to perform a proper cleanup.
`private java.lang.String`	`userName`
`private java.lang.String`	`userPassword`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`TestConfiguration()` Default embedded configuration
`private`	`TestConfiguration(java.util.Properties props)` This constructor creates a TestConfiguration from a Properties object.
`(package private)`	`TestConfiguration(TestConfiguration copy)` Obtain a new configuration identical to the passed one.
`(package private)`	`TestConfiguration(TestConfiguration copy, JDBCClient client, java.lang.String hostName, int port)`
`(package private)`	`TestConfiguration(TestConfiguration copy, JDBCClient client, java.lang.String hostName, int port, java.lang.String dataBasePath)`
`(package private)`	`TestConfiguration(TestConfiguration copy, java.lang.String ssl)` Obtains a new configuration identical to the passed in one, except for the default SSL mode.
`(package private)`	`TestConfiguration(TestConfiguration copy, java.lang.String logicalDbName, java.lang.String dbName, boolean defaultDb)` Obtain a new configuration identical to the passed in one except for the database name.
`(package private)`	`TestConfiguration(TestConfiguration copy, java.lang.String user, java.lang.String password, java.lang.String passwordToken)` Obtain a new configuration identical to the passed in one except for the default user and password.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) TestConfiguration`	`addConnectionAttributes(java.util.Properties attrs)` Create a copy of this configuration with some additional connection attributes.
`static DatabaseChangeSetup`	`additionalDatabaseDecorator(junit.framework.Test test, java.lang.String logicalDbName)` Decorate a test to use a new database that is created upon the first connection request to the database and shutdown and deleted at tearDown.
`static DatabaseChangeSetup`	`additionalDatabaseDecoratorNoShutdown(junit.framework.Test test, java.lang.String logicalDbName)` Similar to additionalDatabaseDecorator except the database will not be shutdown, only deleted.
`static DatabaseChangeSetup`	`additionalDatabaseDecoratorNoShutdown(junit.framework.Test test, java.lang.String logicalDbName, boolean defaultDB)` Similar to additionalDatabaseDecorator except the database will not be shutdown, only deleted.
`static DatabaseChangeSetup`	`additionalDatabaseDecoratorNoShutdown(junit.framework.Test test, java.lang.String logicalDbName, java.lang.String physicalDbName)` Similar to additionalDatabaseDecorator except the database will not be shutdown, only deleted.
`private static junit.framework.Test`	`bareClientServerSuite(java.lang.Class testClass)` Create a suite of test cases to run in a client/server environment.
`static junit.framework.Test`	`changeSSLDecorator(junit.framework.Test test, java.lang.String ssl)` Decorate a test changing the default ssl mode.
`static junit.framework.Test`	`changeUserDecorator(junit.framework.Test test, java.lang.String user, java.lang.String password)` Decorate a test changing the default user name and password.
`static junit.framework.Test`	`clientExistingServerSuite(java.lang.Class testClass)` Equivalent to 'clientServerSuite' above, but assumes server is already running.
`static junit.framework.Test`	`clientExistingServerSuite(java.lang.Class testClass, java.lang.String hostName, int portNumber)` Create a suite for the passed test class that includes all the default fixtures from the class, wrapped in a existingServerDecorator.
`static junit.framework.Test`	`clientExistingServerSuite(java.lang.Class testClass, java.lang.String hostName, int portNumber, java.lang.String dbPath)`
`static junit.framework.Test`	`clientServerDecorator(junit.framework.Test suite)` Return a decorator for the passed in tests that sets the configuration for the client to be Derby's JDBC client and to start the network server at setUp.
`static junit.framework.Test`	`clientServerDecoratorWithAlternativePort(junit.framework.Test suite)` Wrapper to use the alternative port number.
`static junit.framework.Test`	`clientServerDecoratorWithPort(junit.framework.Test suite, int port)` Return a decorator for the passed in tests that sets the configuration for the client to be Derby's JDBC client and to start the network server at setUp.
`static junit.framework.Test`	`clientServerSuite(java.lang.Class testClass)` Create a suite for the passed test class that includes all the default fixtures from the class, wrapped in a derbyClientServerDecorator.
`static junit.framework.Test`	`clientServerSuiteWithAlternativePort(java.lang.Class testClass)` Create a suite for the passed test class that includes all the default fixtures from the class, wrapped in a derbyClientServerDecorator with alternative port.
`static junit.framework.Test`	`connectionCPDecorator(junit.framework.Test test)` Return a decorator that changes the configuration to obtain connections from a ConnectionPoolDataSource using `getPooledConnection().getConnection()` Note that statement pooling is enabled in the data source and in all the connections created from it.
`static junit.extensions.TestSetup`	`connectionDSDecorator(junit.framework.Test test)` Return a decorator that changes the configuration to obtain connections from a standard DataSource using `getConnection()` The tearDown reverts the configuration to the previous configuration.
`static junit.framework.Test`	`connectionXADecorator(junit.framework.Test test)` Return a decorator that changes the configuration to obtain connections from an XADataSource using `getXAConnection().getConnection()` The connection is not connected to any global transaction, thus it is in local connection mode.
`private java.lang.String`	`createJDBCUrlWithDatabaseName(java.lang.String name)` Create JDBC connection url, including the name of the database.
`static junit.framework.Test`	`defaultExistingServerDecorator(junit.framework.Test test)` Decorate a test to use suite's default host and port, but assuming the server is already running.
`static junit.framework.Test`	`defaultExistingServerSuite(java.lang.Class testClass)` Equivalent to "defaultSuite" as defined above, but assumes a server has already been started.
`static junit.framework.Test`	`defaultExistingServerSuite(java.lang.Class testClass, boolean cleanDB)` Does the work of "defaultExistingServerSuite" as defined above.
`(package private) boolean`	`defaultSecurityManagerSetup()` Install the default security manager setup, for the current configuration.
`static junit.framework.Test`	`defaultServerDecorator(junit.framework.Test test)` Decorate a test to use suite's default host and port.
`static junit.framework.Test`	`defaultServerDecoratorWithAlternativePort(junit.framework.Test test)` Decorate a test to use suite's default host and Alternative port.
`static junit.framework.Test`	`defaultSuite(java.lang.Class testClass)` Return a Test suite that contains all the test fixtures for the passed in class running in embedded and the default client server configuration.
`static junit.framework.Test`	`defaultSuite(java.lang.Class testClass, boolean cleanDB)` Does the work of "defaultSuite" as defined above.
`boolean`	`doTrace()` Return JUnit test method trace flag.
`static junit.framework.Test`	`embeddedSuite(java.lang.Class testClass)` Create a suite for the passed test class that includes all the default fixtures from the class.
`static junit.framework.Test`	`existingServerDecorator(junit.framework.Test test, java.lang.String hostName, int PortNumber)` A variant of defaultServerDecorator allowing non-default hostname and portnumber.
`static junit.framework.Test`	`existingServerDecorator(junit.framework.Test test, java.lang.String hostName, int PortNumber, java.lang.String dbPath)` A variant of defaultServerDecorator allowing non-default hostname, portnumber and database name.
`static junit.framework.Test`	`existingServerSuite(java.lang.Class testClass, boolean cleanDB, java.lang.String hostName, int portNumber)` Return a Test suite that contains all the test fixtures for the passed in class running in client server configuration on an already started server on a given host and port number.
`static junit.framework.Test`	`existingServerSuite(java.lang.Class testClass, boolean cleanDB, java.lang.String hostName, int portNumber, java.lang.String dbPath)`
`static junit.framework.Test`	`forceJDBC3Embedded(junit.framework.Test test)` Returns a decorator that forces the JDBC 3 embedded client in a Java SE 6/JDBC 4 environment.
`static junit.framework.Test`	`forceJDBC3NetClient(junit.framework.Test test)` Returns a decorator that forces the JDBC 3 network client in a Java SE 6/JDBC 4 environment.
`static junit.framework.Test`	`forceJDBC3Suite(java.lang.Class testClass)` Return a Test suite that contains all the test fixtures for the passed in class running in embedded and client- server JDBC3 configurations.
`static java.lang.String`	`generateUniqueDatabaseName()` Generate the unique database name for single use.
`private java.lang.String`	`getAndVetPhysicalDatabaseName(java.lang.String logicalDatabaseName)`
`static int`	`getBasePort()`
`int`	`getBogusPort()` Returns a port number where no Derby network servers are supposed to be running.
`java.util.Properties`	`getConnectionAttributes()` Return the connection attributes to use in this configuration.
`(package private) java.lang.String`	`getConnectionAttributesString()` Get a flat string representation of the connection attributes.
`static TestConfiguration`	`getCurrent()` Get this Thread's current configuraiton for running the tests.
`java.lang.String`	`getDatabasePath(java.lang.String physicalDatabaseName)`
`java.lang.String`	`getDefaultDatabaseName()` Return the default database name.
`(package private) java.io.File`	`getFailureFolder(junit.framework.TestCase test)` Get a folder already created where a test can write its failure information.
`java.lang.String`	`getHostName()` Return the host name for the network server.
`JDBCClient`	`getJDBCClient()` Get configured JDBCClient object.
`java.lang.String`	`getJDBCUrl()` Return the jdbc url for connecting to the default database.
`java.lang.String`	`getJDBCUrl(java.lang.String databaseName)` Return the jdbc url for a connecting to the database.
`int`	`getJmxPort()` Gets the value of the port number that may be used for "remote" JMX monitoring and management.
`int`	`getLoginTimeout()` Get the login timeout from the connector
`int`	`getNextAvailablePort()` Get the next available port.
`java.lang.String`	`getPassword(java.lang.String user)` Get the password that is a function of the user name and the token for the current configuration.
`(package private) static java.lang.String`	`getPassword(java.lang.String user, java.lang.String token)` Get the password that is a function of the user name and the passed in token.
`java.lang.String`	`getPhysicalDatabaseName(java.lang.String logicalName)` Return the physical name for a database given its logical name.
`int`	`getPort()` Get port number for network server.
`static ReleaseRepository`	`getReleaseRepository()` Returns the release repository containing old Derby releases available on the local system.
`java.lang.String`	`getSsl()` Get ssl mode for network server
`static java.util.Properties`	`getSystemProperties()` Get the system properties in a privileged block.
`java.lang.String`	`getUserName()` Return the user name.
`java.lang.String`	`getUserPassword()` Return the user password.
`private void`	`initConnector(Connector oldConnector)` Initialize the connection factory.
`static boolean`	`isDefaultBasePort()` Return if the base port is default or not.
`boolean`	`isVerbose()` Return verbose flag.
`static boolean`	`loadingFromJars()` Return true if we classes are being loaded from jar files.
`(package private) java.sql.Connection`	`openConnection(java.lang.String logicalDatabaseName)` Open connection to the specified database.
`java.sql.Connection`	`openConnection(java.lang.String logicalDatabaseName, java.lang.String user, java.lang.String password)` Open connection to the specified database using the supplied username and password.
`java.sql.Connection`	`openDefaultConnection()` Open connection to the default database.
`(package private) java.sql.Connection`	`openDefaultConnection(java.lang.String user, java.lang.String password)` Open connection to the default database.
`java.sql.Connection`	`openPhysicalConnection(java.lang.String physicalDatabaseName, java.lang.String user, java.lang.String password, java.util.Properties props)` Open connection to the specified database using the supplied username and password.
`private void`	`println(java.lang.CharSequence msg)` Private method printing debug information to standard out if debugging is enabled.
`(package private) static void`	`setCurrent(TestConfiguration config)` WORK IN PROGRESS Set this Thread's current configuration for running tests.
`void`	`setLoginTimeout(int seconds)` Set the login timeout for the connector.
`void`	`setTrace(boolean isChatty)` Set JUnit test method tracing.
`void`	`setVerbosity(boolean isChatty)` Set the verbosity, i.e., whether debug statements print.
`void`	`shutdownDatabase()` Shutdown the database for this configuration assuming it is booted.
`void`	`shutdownEngine()` Shutdown the engine for this configuration assuming it is booted.
`void`	`shutdownEngine(boolean deregisterDeriver)` Shutdown the engine for this configuration assuming it is booted.
`static junit.extensions.TestSetup`	`singleUseDatabaseDecorator(junit.framework.Test test)` Decorate a test to use a new database that is created upon the first connection request to the database and shutdown and deleted at tearDown.
`static junit.extensions.TestSetup`	`singleUseDatabaseDecorator(junit.framework.Test test, java.lang.String dbName)` Decorate a test to use a new database that is created upon the first connection request to the database and shutdown and deleted at tearDown.
`static junit.extensions.TestSetup`	`singleUseDatabaseDecoratorNoShutdown(junit.framework.Test test)` Decorate a test to use a new database that is created upon the first connection request to the database and deleted at tearDown.
`static junit.framework.Test`	`sqlAuthorizationDecorator(junit.framework.Test test)` Decorate a test to use the default database that has was created in SQL authorization mode.
`static junit.framework.Test`	`sqlAuthorizationDecorator(junit.framework.Test test, java.lang.String[] users, java.lang.String passwordToken)` Utility version of sqlAuthorizationDecorator that also sets up authentication.
`static junit.framework.Test`	`sqlAuthorizationDecoratorSingleUse(junit.framework.Test test)` Same as sqlAuthorizationDecorator, except that the database is dropped at teardown and the test is responsible for shutting down the database.
`static junit.framework.Test`	`sqlAuthorizationDecoratorSingleUse(junit.framework.Test test, java.lang.String dbName, boolean shutdownDatabase)` Same as sqlAuthorizationDecoratorSingleUse, except that you can name the database yourself, and you can choose whether or not the decorator should shut down the database before it attempts to drop it.
`void`	`startNetworkServer()` starts the Networs server for this configuration.
`boolean`	`stopAfterFirstFail()`
`void`	`stopNetworkServer()` stops the Network server for this configuration.
`(package private) static java.lang.String`	`suiteName(java.lang.Class testClass)` Generate a suite name from a class name, taking only the last element of the fully qualified class name.
`private static boolean`	`supportsClientServer()` Check if client and server testing is supported in the test environment.
`void`	`waitForShutdownComplete(java.lang.String physicalDatabaseName)`

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

- Field Detail
  - DEFAULT_DBNAME
```
private static final java.lang.String DEFAULT_DBNAME
```
    Default values for configurations
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DBNAME_SQL
```
private static final java.lang.String DEFAULT_DBNAME_SQL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_USER_NAME
```
private static final java.lang.String DEFAULT_USER_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_USER_PASSWORD
```
private static final java.lang.String DEFAULT_USER_PASSWORD
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
private static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FRAMEWORK
```
private static final java.lang.String DEFAULT_FRAMEWORK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HOSTNAME
```
private static final java.lang.String DEFAULT_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - LOCKFILETIMEOUT
```
private static final int LOCKFILETIMEOUT
```
    See Also:
    
    Constant Field Values
  - MAX_PORTS_USED
```
private static final int MAX_PORTS_USED
```
    Maximum number of ports used by Suites.All If this changes, this constant and the Wiki page at http://wiki.apache.org/db-derby/DerbyJUnitTesting need to be updated.
    
    See Also:
    
    Constant Field Values
  - basePort
```
private static final int basePort
```
    This is the base port. This does NOT change EVER during the run of a suite. It is set using the property derby.tests.basePort and it is set to default when a property isn't used.
  - lastAssignedPort
```
private static int lastAssignedPort
```
  - bogusPort
```
private static final int bogusPort
```
  - assignedPortCount
```
private static int assignedPortCount
```
  - serverOutput
```
private java.io.FileOutputStream serverOutput
```
  - SLEEP_TIME
```
private static final int SLEEP_TIME
```
    Sleep for 1000 ms before pinging the network server (again)
    
    See Also:
    
    Constant Field Values
  - KEY_DBNAME
```
private static final java.lang.String KEY_DBNAME
```
    Keys to use to look up values in properties files.
    
    See Also:
    
    Constant Field Values
  - KEY_FRAMEWORK
```
private static final java.lang.String KEY_FRAMEWORK
```
    See Also:
    
    Constant Field Values
  - KEY_USER_PASSWORD
```
private static final java.lang.String KEY_USER_PASSWORD
```
    See Also:
    
    Constant Field Values
  - KEY_USER_NAME
```
private static final java.lang.String KEY_USER_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_HOSTNAME
```
private static final java.lang.String KEY_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - KEY_PORT
```
private static final java.lang.String KEY_PORT
```
    See Also:
    
    Constant Field Values
  - KEY_VERBOSE
```
private static final java.lang.String KEY_VERBOSE
```
    See Also:
    
    Constant Field Values
  - KEY_LOGIN_TIMEOUT
```
private static final java.lang.String KEY_LOGIN_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - KEY_TRACE
```
private static final java.lang.String KEY_TRACE
```
    See Also:
    
    Constant Field Values
  - KEY_OMIT_LUCENE
```
public static final java.lang.String KEY_OMIT_LUCENE
```
    See Also:
    
    Constant Field Values
  - KEY_OMIT_JSON
```
public static final java.lang.String KEY_OMIT_JSON
```
    See Also:
    
    Constant Field Values
  - KEY_STOP_AFTER_FIRST_FAIL
```
private static final java.lang.String KEY_STOP_AFTER_FIRST_FAIL
```
    derby.tests.stopAfterFirstFail - debugging property to exit after first failure. Can be useful for debugging cascading failures or errors that lead to hang scenario.
    
    See Also:
    
    Constant Field Values
  - KEY_SSL
```
private static final java.lang.String KEY_SSL
```
    See Also:
    
    Constant Field Values
  - KEY_JMX_PORT
```
private static final java.lang.String KEY_JMX_PORT
```
    See Also:
    
    Constant Field Values
  - uniqueDB
```
private static int uniqueDB
```
    Simple count to provide a unique number for database names.
  - releaseRepository
```
private static ReleaseRepository releaseRepository
```
    Repository of old/previous Derby releases available on the local system.
  - JUNIT_CONFIG
```
private static final TestConfiguration JUNIT_CONFIG
```
    Default configuration for standalone JUnit tests, an embedded configuration.
  - DEFAULT_CONFIG
```
private static final TestConfiguration DEFAULT_CONFIG
```
    The default configuration.
  - CURRENT_CONFIG
```
private static final java.lang.ThreadLocal<TestConfiguration> CURRENT_CONFIG
```
    Current configuration is stored in a ThreadLocal to allow the potential for multiple tests to be running concurrently with different configurations.
  - defaultDbName
```
private final java.lang.String defaultDbName
```
    The default database name for tests.
  - usedDbNames
```
private final java.util.ArrayList<java.lang.String> usedDbNames
```
    Holds the names of all other databases used in a test to perform a proper cleanup. The defaultDbName is also contained here.
  - logicalDbMapping
```
private final java.util.HashMap<java.lang.String,java.lang.String> logicalDbMapping
```
    Contains the mapping of logical database names to physical database names.
  - url
```
private final java.lang.String url
```
  - userName
```
private final java.lang.String userName
```
  - userPassword
```
private final java.lang.String userPassword
```
  - port
```
private final int port
```
  - hostName
```
private final java.lang.String hostName
```
  - jdbcClient
```
private final JDBCClient jdbcClient
```
  - jmxPort
```
private final int jmxPort
```
  - isVerbose
```
private boolean isVerbose
```
  - doTrace
```
private boolean doTrace
```
  - stopAfterFirstFail
```
private boolean stopAfterFirstFail
```
  - ssl
```
private java.lang.String ssl
```
  - connectionAttributes
```
private java.util.Properties connectionAttributes
```
    Extra connection attributes. Not for user name and password, use the fields userName and userPassword for those attributes.
  - passwordToken
```
private java.lang.String passwordToken
```
    Password token used by the builtin authentication decorators. Default simple scheme is the password is a function of the user and a password token. password token is set by DatabasePropertyTestSetup.builtinAuthentication
  - connector
```
Connector connector
```
    Indirection for obtaining connections based upon this configuration.
- Constructor Detail
  - TestConfiguration
```
private TestConfiguration()
```
    Default embedded configuration
  - TestConfiguration
```
TestConfiguration(TestConfiguration copy)
```
    Obtain a new configuration identical to the passed one.
  - TestConfiguration
```
TestConfiguration(TestConfiguration copy,
                  JDBCClient client,
                  java.lang.String hostName,
                  int port)
```
  - TestConfiguration
```
TestConfiguration(TestConfiguration copy,
                  JDBCClient client,
                  java.lang.String hostName,
                  int port,
                  java.lang.String dataBasePath)
```
  - TestConfiguration
```
TestConfiguration(TestConfiguration copy,
                  java.lang.String user,
                  java.lang.String password,
                  java.lang.String passwordToken)
```
    Obtain a new configuration identical to the passed in one except for the default user and password.
    
    Parameters:
    
    copy - Configuration to copy.
    
    user - New default user
    
    password - New default password.
  - TestConfiguration
```
TestConfiguration(TestConfiguration copy,
                  java.lang.String ssl)
```
    Obtains a new configuration identical to the passed in one, except for the default SSL mode.
    The modes supported at the moment are basic and off. The mode peerAuthentication is not yet supported.
    
    Parameters:
    
    copy - configuration to copy
    
    ssl - default SSL mode
  - TestConfiguration
```
TestConfiguration(TestConfiguration copy,
                  java.lang.String logicalDbName,
                  java.lang.String dbName,
                  boolean defaultDb)
```
    Obtain a new configuration identical to the passed in one except for the database name. The passed database name is added at the end of the list of used databases. If the defaulDb parameter is true the new database name is used as a default database.
    
    Parameters:
    
    copy - Configuration to copy.
    
    dbName - New database name
    
    defaultDb - Indicates that the passed dbName is supposed to be used as the default database name.
  - TestConfiguration
```
private TestConfiguration(java.util.Properties props)
                   throws java.lang.NumberFormatException
```
    This constructor creates a TestConfiguration from a Properties object.
    
    Throws:
    
    java.lang.NumberFormatException - if the port specification is not an integer.
- Method Detail
  - getCurrent
```
public static TestConfiguration getCurrent()
```
    Get this Thread's current configuraiton for running the tests. Note this call must only be used while a test is running, they make no sense when setting up a suite. A suite itself sets up which test configurations the fixtures will run in.
    
    Returns:
    
    TestConfiguration to use.
  - getReleaseRepository
```
public static ReleaseRepository getReleaseRepository()
```
    Returns the release repository containing old Derby releases available on the local system.
    NOTE: It is your responsibility to keep the repository up to date. This usually involves syncing the local Subversion repository of previous Derby releases with the master repository at Apache.
    
    See Also:
    
    ReleaseRepository
  - setCurrent
```
static void setCurrent(TestConfiguration config)
```
    WORK IN PROGRESS Set this Thread's current configuration for running tests.
    
    Parameters:
    
    config - Configuration to set it to.
  - defaultSuite
```
public static junit.framework.Test defaultSuite(java.lang.Class testClass)
```
    Return a Test suite that contains all the test fixtures for the passed in class running in embedded and the default client server configuration.
    Each set of embedded and set of client server tests is decorated with a CleanDatabaseTestSetup.
    The client server configuration is setup using clientServerSuite
  - defaultSuite
```
public static junit.framework.Test defaultSuite(java.lang.Class testClass,
                                                boolean cleanDB)
```
    Does the work of "defaultSuite" as defined above. Takes a boolean argument to determine whether or not to "clean" the test database before each suite. If the resultant suite is going to be wrapped inside a TestSetup that creates database objects to be used throughout the tests, then the cleanDB parameter should be "false" to prevent cleanup of the database objects that TestSetup created. For example, see XMLBindingTest.suite().
  - defaultExistingServerSuite
```
public static junit.framework.Test defaultExistingServerSuite(java.lang.Class testClass)
```
    Equivalent to "defaultSuite" as defined above, but assumes a server has already been started.
    Does NOT decorate for running in embedded mode, only for running on the already started server.
    Return a Test suite that contains all the test fixtures for the passed in class running in client server configuration on an already started server.
    The set of client server tests is decorated with a CleanDatabaseTestSetup.
    The client server configuration is setup using clientExistingServerSuite
  - defaultExistingServerSuite
```
public static junit.framework.Test defaultExistingServerSuite(java.lang.Class testClass,
                                                              boolean cleanDB)
```
    Does the work of "defaultExistingServerSuite" as defined above. Takes a boolean argument to determine whether or not to "clean" the test database before each suite. If the resultant suite is going to be wrapped inside a TestSetup that creates database objects to be used throughout the tests, then the cleanDB parameter should be "false" to prevent cleanup of the database objects that TestSetup created.
    Does NOT decorate for running in embedded mode, only for running on an already started server.
  - existingServerSuite
```
public static junit.framework.Test existingServerSuite(java.lang.Class testClass,
                                                       boolean cleanDB,
                                                       java.lang.String hostName,
                                                       int portNumber)
```
    Return a Test suite that contains all the test fixtures for the passed in class running in client server configuration on an already started server on a given host and port number.
    Takes a boolean argument to determine whether or not to "clean" the test database before each suite. If the resultant suite is going to be wrapped inside a TestSetup that creates database objects to be used throughout the tests, then the cleanDB parameter should be "false" to prevent cleanup of the database objects that TestSetup created.
    Takes a String argument to specify which host the server runs on, and takes an int argument to specify the port number to use.
    Does NOT decorate for running in embedded mode, only for running on an already started server.
    The set of client server tests is decorated with a CleanDatabaseTestSetup.
    The client server configuration is setup using clientExistingServerSuite
  - existingServerSuite
```
public static junit.framework.Test existingServerSuite(java.lang.Class testClass,
                                                       boolean cleanDB,
                                                       java.lang.String hostName,
                                                       int portNumber,
                                                       java.lang.String dbPath)
```
  - forceJDBC3Suite
```
public static junit.framework.Test forceJDBC3Suite(java.lang.Class testClass)
```
    Return a Test suite that contains all the test fixtures for the passed in class running in embedded and client- server *JDBC3* configurations.
    Each set of embedded and set of client server tests is decorated with a CleanDatabaseTestSetup.
  - suiteName
```
static java.lang.String suiteName(java.lang.Class testClass)
```
    Generate a suite name from a class name, taking only the last element of the fully qualified class name.
  - embeddedSuite
```
public static junit.framework.Test embeddedSuite(java.lang.Class testClass)
```
    Create a suite for the passed test class that includes all the default fixtures from the class.
  - clientServerSuite
```
public static junit.framework.Test clientServerSuite(java.lang.Class testClass)
```
    Create a suite for the passed test class that includes all the default fixtures from the class, wrapped in a derbyClientServerDecorator.
  - clientServerSuiteWithAlternativePort
```
public static junit.framework.Test clientServerSuiteWithAlternativePort(java.lang.Class testClass)
```
    Create a suite for the passed test class that includes all the default fixtures from the class, wrapped in a derbyClientServerDecorator with alternative port.
  - clientExistingServerSuite
```
public static junit.framework.Test clientExistingServerSuite(java.lang.Class testClass)
```
    Equivalent to 'clientServerSuite' above, but assumes server is already running.
  - clientExistingServerSuite
```
public static junit.framework.Test clientExistingServerSuite(java.lang.Class testClass,
                                                             java.lang.String hostName,
                                                             int portNumber)
```
    Create a suite for the passed test class that includes all the default fixtures from the class, wrapped in a existingServerDecorator.
    Equivalent to 'clientServerSuite' above, but assumes server is already running. Will also NOT shut down the server.
  - clientExistingServerSuite
```
public static junit.framework.Test clientExistingServerSuite(java.lang.Class testClass,
                                                             java.lang.String hostName,
                                                             int portNumber,
                                                             java.lang.String dbPath)
```
  - clientServerDecorator
```
public static junit.framework.Test clientServerDecorator(junit.framework.Test suite)
```
    Return a decorator for the passed in tests that sets the configuration for the client to be Derby's JDBC client and to start the network server at setUp.
    The database configuration (name etc.) is based upon the previous configuration.
    The previous TestConfiguration is restored at tearDown and the network server is shutdown.
    
    Parameters:
    
    suite - the suite to decorate
  - clientServerDecoratorWithPort
```
public static junit.framework.Test clientServerDecoratorWithPort(junit.framework.Test suite,
                                                                 int port)
```
    Return a decorator for the passed in tests that sets the configuration for the client to be Derby's JDBC client and to start the network server at setUp.
    The database configuration (name etc.) is based upon the previous configuration.
    The previous TestConfiguration is restored at tearDown and the network server is shutdown.
    
    Parameters:
    
    suite - the suite to decorate
  - clientServerDecoratorWithAlternativePort
```
public static junit.framework.Test clientServerDecoratorWithAlternativePort(junit.framework.Test suite)
```
    Wrapper to use the alternative port number.
  - defaultExistingServerDecorator
```
public static junit.framework.Test defaultExistingServerDecorator(junit.framework.Test test)
```
    Decorate a test to use suite's default host and port, but assuming the server is already running.
  - defaultServerDecorator
```
public static junit.framework.Test defaultServerDecorator(junit.framework.Test test)
```
    Decorate a test to use suite's default host and port.
  - existingServerDecorator
```
public static junit.framework.Test existingServerDecorator(junit.framework.Test test,
                                                           java.lang.String hostName,
                                                           int PortNumber)
```
    A variant of defaultServerDecorator allowing non-default hostname and portnumber.
  - existingServerDecorator
```
public static junit.framework.Test existingServerDecorator(junit.framework.Test test,
                                                           java.lang.String hostName,
                                                           int PortNumber,
                                                           java.lang.String dbPath)
```
    A variant of defaultServerDecorator allowing non-default hostname, portnumber and database name.
  - defaultServerDecoratorWithAlternativePort
```
public static junit.framework.Test defaultServerDecoratorWithAlternativePort(junit.framework.Test test)
```
    Decorate a test to use suite's default host and Alternative port.
  - supportsClientServer
```
private static boolean supportsClientServer()
```
    Check if client and server testing is supported in the test environment.
  - bareClientServerSuite
```
private static junit.framework.Test bareClientServerSuite(java.lang.Class testClass)
```
    Create a suite of test cases to run in a client/server environment. The returned test suite is not decorated with a ServerSetup.
    
    Parameters:
    
    testClass - the class from which to extract the test cases
    
    Returns:
    
    a test suite with all the test cases in testClass, or an empty test suite if client/server is not supported in the test environment
  - generateUniqueDatabaseName
```
public static java.lang.String generateUniqueDatabaseName()
```
    Generate the unique database name for single use.
  - singleUseDatabaseDecorator
```
public static junit.extensions.TestSetup singleUseDatabaseDecorator(junit.framework.Test test)
```
    Decorate a test to use a new database that is created upon the first connection request to the database and shutdown and deleted at tearDown. The configuration differs only from the current configuration by the list of used databases. The new database name is generated automatically as 'singleUse/oneuseXX' where 'XX' is the unique number. The generated database name is added at the end of usedDbNames and assigned as a default database name. This decorator expects the database file to be local so it can be removed.
    
    Parameters:
    
    test - Test to be decorated
    
    Returns:
    
    decorated test.
  - singleUseDatabaseDecorator
```
public static junit.extensions.TestSetup singleUseDatabaseDecorator(junit.framework.Test test,
                                                                    java.lang.String dbName)
```
    Decorate a test to use a new database that is created upon the first connection request to the database and shutdown and deleted at tearDown. The configuration differs only from the current configuration by the list of used databases. The generated database name is added at the end of usedDbNames and assigned as a default database name. This decorator expects the database file to be local so it can be removed.
    
    Parameters:
    
    test - Test to be decorated
    
    dbName - We sometimes need to know outside to be able to pass it on to other VMs/processes.
    
    Returns:
    
    decorated test.
  - singleUseDatabaseDecoratorNoShutdown
```
public static junit.extensions.TestSetup singleUseDatabaseDecoratorNoShutdown(junit.framework.Test test)
```
    Decorate a test to use a new database that is created upon the first connection request to the database and deleted at tearDown. In contrast to plain singleUseDatabaseDecorator, the database is expected to be shutdown by the test. The configuration differs only from the current configuration by the list of used databases. The new database name is generated automatically as 'singleUse/oneuseXX' where 'XX' is the unique number. The generated database name is added at the end of usedDbNames and assigned as a default database name. This decorator expects the database file to be local so it can be removed.
    
    Parameters:
    
    test - Test to be decorated
    
    Returns:
    
    decorated test.
  - additionalDatabaseDecorator
```
public static DatabaseChangeSetup additionalDatabaseDecorator(junit.framework.Test test,
                                                              java.lang.String logicalDbName)
```
    Decorate a test to use a new database that is created upon the first connection request to the database and shutdown and deleted at tearDown. The configuration differs only from the current configuration by the list of used databases. The passed database name is mapped to the generated database name 'singleUse/oneuseXX' where 'XX' is the unique number. (by generateUniqueDatabaseName). The generated database name is added at the end of usedDbNames. This decorator expects the database file to be local so it can be removed.
    
    Parameters:
    
    test - Test to be decorated
    
    logicalDbName - The logical database name. This name is used to identify the database in openConnection(String logicalDatabaseName) method calls.
    
    Returns:
    
    decorated test.
  - additionalDatabaseDecoratorNoShutdown
```
public static DatabaseChangeSetup additionalDatabaseDecoratorNoShutdown(junit.framework.Test test,
                                                                        java.lang.String logicalDbName)
```
    Similar to additionalDatabaseDecorator except the database will not be shutdown, only deleted. It is the responsibility of the test to shut it down.
    
    Parameters:
    
    test - Test to be decorated
    
    logicalDbName - The logical database name. This name is used to identify the database in openConnection(String logicalDatabaseName) method calls.
    
    Returns:
    
    decorated test.
  - additionalDatabaseDecoratorNoShutdown
```
public static DatabaseChangeSetup additionalDatabaseDecoratorNoShutdown(junit.framework.Test test,
                                                                        java.lang.String logicalDbName,
                                                                        boolean defaultDB)
```
    Similar to additionalDatabaseDecorator except the database will not be shutdown, only deleted. It is the responsibility of the test to shut it down.
    
    Parameters:
    
    test - Test to be decorated
    
    logicalDbName - The logical database name. This name is used to identify the database in openConnection(String logicalDatabaseName) method calls.
    
    defaultDB - True if the database should store its own name in its TestConfiguration.
    
    Returns:
    
    decorated test.
  - additionalDatabaseDecoratorNoShutdown
```
public static DatabaseChangeSetup additionalDatabaseDecoratorNoShutdown(junit.framework.Test test,
                                                                        java.lang.String logicalDbName,
                                                                        java.lang.String physicalDbName)
```
    Similar to additionalDatabaseDecorator except the database will not be shutdown, only deleted. It is the responsibility of the test to shut it down.
    
    Parameters:
    
    test - Test to be decorated
    
    logicalDbName - The logical database name. This name is used to identify the database in openConnection(String logicalDatabaseName) method calls.
    
    physicalDbName - - Real database name on disk.
    
    Returns:
    
    decorated test.
  - changeUserDecorator
```
public static junit.framework.Test changeUserDecorator(junit.framework.Test test,
                                                       java.lang.String user,
                                                       java.lang.String password)
```
    Decorate a test changing the default user name and password. Typically used along with DatabasePropertyTestSetup.builtinAuthentication. The tearDown method resets the default user and password value to their previous settings.
    
    Parameters:
    
    test - Test to decorate
    
    user - New default user
    
    password - New password
    
    Returns:
    
    decorated test
    
    See Also:
    
    DatabasePropertyTestSetup.builtinAuthentication(Test, String[], String)
  - sqlAuthorizationDecorator
```
public static junit.framework.Test sqlAuthorizationDecorator(junit.framework.Test test)
```
    Decorate a test to use the default database that has was created in SQL authorization mode. The tearDown reverts the configuration to the previous configuration. The database owner of this default SQL authorization mode database is TEST_DBO. This decorator sets the default user to be TEST_DBO. Tests can use this in conjunction with DatabasePropertyTestSetup.builtinAuthentication to set up BUILTIN authentication and changeUserDecorator to switch users. The database owner TEST_DBO must be included in the list of users provided to builtinAuthentication. This decorator must be the outer one in this mode. test = DatabasePropertyTestSetup.builtinAuthentication(test, new String[] {TEST_DBO,"U1","U2",}, "nh32ew"); test = TestConfiguration.sqlAuthorizationDecorator(test); A utility version of sqlAuthorizationDecorator is provided that combines the two setups.
    
    Parameters:
    
    test - Test to be decorated
    
    Returns:
    
    decorated test.
    
    See Also:
    
    DatabasePropertyTestSetup.builtinAuthentication(Test, String[], String)
  - sqlAuthorizationDecoratorSingleUse
```
public static junit.framework.Test sqlAuthorizationDecoratorSingleUse(junit.framework.Test test)
```
    Same as sqlAuthorizationDecorator, except that the database is dropped at teardown and the test is responsible for shutting down the database.
    
    Parameters:
    
    test - Test to be decorated
    
    Returns:
    
    decorated test.
    
    See Also:
    
    sqlAuthorizationDecorator(Test test)
  - sqlAuthorizationDecoratorSingleUse
```
public static junit.framework.Test sqlAuthorizationDecoratorSingleUse(junit.framework.Test test,
                                                                      java.lang.String dbName,
                                                                      boolean shutdownDatabase)
```
    Same as sqlAuthorizationDecoratorSingleUse, except that you can name the database yourself, and you can choose whether or not the decorator should shut down the database before it attempts to drop it.
    
    Parameters:
    
    test - Test to be decorated
    
    dbName - The name of the database to use in the test
    
    shutdownDatabase - Whether or not to shut down the database before it is dropped
    
    Returns:
    
    decorated test.
    
    See Also:
    
    sqlAuthorizationDecorator(Test test)
  - sqlAuthorizationDecorator
```
public static junit.framework.Test sqlAuthorizationDecorator(junit.framework.Test test,
                                                             java.lang.String[] users,
                                                             java.lang.String passwordToken)
```
    Utility version of sqlAuthorizationDecorator that also sets up authentication. A combination of DatabasePropertyTestSetup.builtinAuthentication wrapped in sqlAuthorizationDecorator.
    The database owner of this default SQL authorization mode database is TEST_DBO. This decorator sets the default user to be TEST_DBO.
    Assumption is that no authentication is enabled on the default SQL authorization database on entry.
    
    Parameters:
    
    users - Set of users excluding the database owner, that will be added by this decorator.
  - connectionCPDecorator
```
public static junit.framework.Test connectionCPDecorator(junit.framework.Test test)
```
    Return a decorator that changes the configuration to obtain connections from a ConnectionPoolDataSource using getPooledConnection().getConnection()
    Note that statement pooling is enabled in the data source and in all the connections created from it.
    The tearDown reverts the configuration to the previous configuration.
    
    Parameters:
    
    test - the test/suite to decorate
    
    Returns:
    
    A test setup with the requested decorator.
  - connectionXADecorator
```
public static junit.framework.Test connectionXADecorator(junit.framework.Test test)
```
    Return a decorator that changes the configuration to obtain connections from an XADataSource using getXAConnection().getConnection() The connection is not connected to any global transaction, thus it is in local connection mode. The tearDown reverts the configuration to the previous configuration.
  - connectionDSDecorator
```
public static junit.extensions.TestSetup connectionDSDecorator(junit.framework.Test test)
```
    Return a decorator that changes the configuration to obtain connections from a standard DataSource using getConnection() The tearDown reverts the configuration to the previous configuration.
  - forceJDBC3Embedded
```
public static junit.framework.Test forceJDBC3Embedded(junit.framework.Test test)
```
    Returns a decorator that forces the JDBC 3 embedded client in a Java SE 6/JDBC 4 environment. The only difference is that the DataSource class names will be the "old" JDBC 3 versions and not the JDBC 4 specific ones. that
    
    Parameters:
    
    test -
  - forceJDBC3NetClient
```
public static junit.framework.Test forceJDBC3NetClient(junit.framework.Test test)
```
    Returns a decorator that forces the JDBC 3 network client in a Java SE 6/JDBC 4 environment. The only difference is that the DataSource class names will be the "old" JDBC 3 versions and not the JDBC 4 specific ones. Assumption is that the received Test is an instance of ServerSetup, which is the decorator for client server tests. If that is not the case then this method is a no-op.
    
    Parameters:
    
    test - Test around which to wrap the JDBC 3 network client configuration.
  - changeSSLDecorator
```
public static junit.framework.Test changeSSLDecorator(junit.framework.Test test,
                                                      java.lang.String ssl)
```
    Decorate a test changing the default ssl mode. The tearDown method resets the default user and password value to their previous settings.
    
    Parameters:
    
    test - Test to decorate
    
    ssl - New ssl mode
    
    Returns:
    
    decorated test
  - addConnectionAttributes
```
TestConfiguration addConnectionAttributes(java.util.Properties attrs)
```
    Create a copy of this configuration with some additional connection attributes.
    
    Parameters:
    
    attrs - the extra connection attributes
    
    Returns:
    
    a copy of the configuration with extra attributes
  - getSystemProperties
```
public static final java.util.Properties getSystemProperties()
```
    Get the system properties in a privileged block.
    
    Returns:
    
    the system properties.
  - createJDBCUrlWithDatabaseName
```
private java.lang.String createJDBCUrlWithDatabaseName(java.lang.String name)
```
    Create JDBC connection url, including the name of the database.
    
    Returns:
    
    JDBC connection url, without attributes.
  - initConnector
```
private void initConnector(Connector oldConnector)
```
    Initialize the connection factory. Defaults to the DriverManager implementation if running JDBC 2.0 or higher, otherwise a DataSource implementation for JSR 169.
  - getJDBCClient
```
public JDBCClient getJDBCClient()
```
    Get configured JDBCClient object.
    
    Returns:
    
    JDBCClient
  - getJDBCUrl
```
public java.lang.String getJDBCUrl()
```
    Return the jdbc url for connecting to the default database.
    
    The returned URL does not include the connection attributes. These must either be appended to the URL when connecting, or they must be passed as a Properties object to DriverManager.getConnection().
    
    Returns:
    
    JDBC url.
  - getJDBCUrl
```
public java.lang.String getJDBCUrl(java.lang.String databaseName)
```
    Return the jdbc url for a connecting to the database.
    
    Parameters:
    
    databaseName - name of database.
    
    Returns:
    
    JDBC connection url, including database name.
  - getDefaultDatabaseName
```
public java.lang.String getDefaultDatabaseName()
```
    Return the default database name.
    
    Returns:
    
    default database name.
  - getPhysicalDatabaseName
```
public java.lang.String getPhysicalDatabaseName(java.lang.String logicalName)
```
    Return the physical name for a database given its logical name.
    
    Returns:
    
    Physical name of the database.
  - getUserName
```
public java.lang.String getUserName()
```
    Return the user name.
    
    Returns:
    
    user name.
  - getUserPassword
```
public java.lang.String getUserPassword()
```
    Return the user password.
    
    Returns:
    
    user password.
  - getConnectionAttributes
```
public java.util.Properties getConnectionAttributes()
```
    Return the connection attributes to use in this configuration. The attributes won't contain user name or password. Use getUserName() or getUserPassword() instead to retrieve those attributes.
    
    Returns:
    
    connection attributes (never null)
  - getConnectionAttributesString
```
java.lang.String getConnectionAttributesString()
```
    Get a flat string representation of the connection attributes. To be used in the connectionAttributes property of a data source.
    
    Returns:
    
    all connection attributes concatenated (null if there are no attributes)
  - getHostName
```
public java.lang.String getHostName()
```
    Return the host name for the network server.
    
    Returns:
    
    host name.
  - isDefaultBasePort
```
public static boolean isDefaultBasePort()
```
    Return if the base port is default or not.
    
    Returns:
    
    true if base port is default.
  - getBasePort
```
public static int getBasePort()
```
  - getPort
```
public int getPort()
```
    Get port number for network server.
    
    Returns:
    
    port number.
  - getNextAvailablePort
```
public int getNextAvailablePort()
```
    Get the next available port. This method is multi-purposed. It can be used for alternative servers and also for JMX and replication.
    
    Returns:
    
    port number.
  - getJmxPort
```
public int getJmxPort()
```
    Gets the value of the port number that may be used for "remote" JMX monitoring and management.
    
    Returns:
    
    the port number on which the JMX MBean server is listening for connections
  - getBogusPort
```
public int getBogusPort()
```
    Returns a port number where no Derby network servers are supposed to be running.
    
    Returns:
    
    A port number where no Derby network servers are started.
  - getSsl
```
public java.lang.String getSsl()
```
    Get ssl mode for network server
    
    Returns:
    
    ssl mode
  - openDefaultConnection
```
public java.sql.Connection openDefaultConnection()
                                          throws java.sql.SQLException
```
    Open connection to the default database. If the database does not exist, it will be created. A default username and password will be used for the connection.
    
    Returns:
    
    connection to default database.
    
    Throws:
    
    java.sql.SQLException
  - openDefaultConnection
```
java.sql.Connection openDefaultConnection(java.lang.String user,
                                          java.lang.String password)
                                   throws java.sql.SQLException
```
    Open connection to the default database. If the database does not exist, it will be created.
    
    Returns:
    
    connection to default database.
    
    Throws:
    
    java.sql.SQLException
  - openConnection
```
java.sql.Connection openConnection(java.lang.String logicalDatabaseName)
                            throws java.sql.SQLException
```
    Open connection to the specified database. If the database does not exist, it will be created. A default username and password will be used for the connection. Requires that the test has been decorated with additionalDatabaseDecorator with the matching name. The physical database name may differ.
    
    Parameters:
    
    logicalDatabaseName - A logical database name as passed to additionalDatabaseDecorator function.
    
    Returns:
    
    connection to specified database.
    
    Throws:
    
    java.sql.SQLException
  - getAndVetPhysicalDatabaseName
```
private java.lang.String getAndVetPhysicalDatabaseName(java.lang.String logicalDatabaseName)
                                                throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - openConnection
```
public java.sql.Connection openConnection(java.lang.String logicalDatabaseName,
                                          java.lang.String user,
                                          java.lang.String password)
                                   throws java.sql.SQLException
```
    Open connection to the specified database using the supplied username and password. If the database does not exist, it will be created. Requires that the test has been decorated with additionalDatabaseDecorator with the matching name. The physical database name may differ.
    
    Parameters:
    
    logicalDatabaseName - A logical database name as passed to additionalDatabaseDecorator function.
    
    Returns:
    
    connection to specified database.
    
    Throws:
    
    java.sql.SQLException
  - openPhysicalConnection
```
public java.sql.Connection openPhysicalConnection(java.lang.String physicalDatabaseName,
                                                  java.lang.String user,
                                                  java.lang.String password,
                                                  java.util.Properties props)
                                           throws java.sql.SQLException
```
    Open connection to the specified database using the supplied username and password. Treat the database name as a physical database name rather than as a logical name which needs to be mapped. If the database does not exist, it will be created. Requires that the test has been decorated with additionalDatabaseDecorator with the matching name.
    
    Parameters:
    
    physicalDatabaseName - The real database name to use.
    
    user - name of user
    
    password - password of user
    
    props - extra properties to pass to the connection
    
    Returns:
    
    connection to specified database.
    
    Throws:
    
    java.sql.SQLException
  - shutdownDatabase
```
public void shutdownDatabase()
```
    Shutdown the database for this configuration assuming it is booted.
  - shutdownEngine
```
public void shutdownEngine()
```
    Shutdown the engine for this configuration assuming it is booted. This method can only be called when the engine is running embedded in this JVM.
  - shutdownEngine
```
public void shutdownEngine(boolean deregisterDeriver)
```
    Shutdown the engine for this configuration assuming it is booted. This method can only be called when the engine is running embedded in this JVM.
    
    Parameters:
    
    deregisterDeriver - if true, deregister the driver
  - getLoginTimeout
```
public int getLoginTimeout()
                    throws java.sql.SQLException
```
    Get the login timeout from the connector
    
    Throws:
    
    java.sql.SQLException
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException
```
    Set the login timeout for the connector.
    
    Parameters:
    
    seconds - the login timeout in seconds
    
    Throws:
    
    java.sql.SQLException - if the timeout cannot be set
  - waitForShutdownComplete
```
public void waitForShutdownComplete(java.lang.String physicalDatabaseName)
```
  - stopNetworkServer
```
public void stopNetworkServer()
```
    stops the Network server for this configuration.
  - startNetworkServer
```
public void startNetworkServer()
                        throws java.sql.SQLException
```
    starts the Networs server for this configuration.
    
    Throws:
    
    java.sql.SQLException
  - setVerbosity
```
public void setVerbosity(boolean isChatty)
```
    Set the verbosity, i.e., whether debug statements print.
  - setTrace
```
public void setTrace(boolean isChatty)
```
    Set JUnit test method tracing.
  - isVerbose
```
public boolean isVerbose()
```
    Return verbose flag.
    
    Returns:
    
    verbose flag.
  - println
```
private void println(java.lang.CharSequence msg)
```
    Private method printing debug information to standard out if debugging is enabled.
    Note: This method may direct output to a different location than the println method in BaseJDBCTestCase.
  - doTrace
```
public boolean doTrace()
```
    Return JUnit test method trace flag.
    
    Returns:
    
    JUnit test method trace flag.
  - stopAfterFirstFail
```
public boolean stopAfterFirstFail()
```
  - loadingFromJars
```
public static boolean loadingFromJars()
```
    Return true if we classes are being loaded from jar files. For the time being, this simply tests that the JVMInfo class (common to the client and the server) comes out of a jar file.
  - getFailureFolder
```
java.io.File getFailureFolder(junit.framework.TestCase test)
```
    Get a folder already created where a test can write its failure information. The name of the folder, relative to ${user.dir} is:
    fail/client/testclass/testname client - value of JDBCClient.getName() for the test's configuration testclass - last element of the class name testname - value of test.getName()
  defaultSecurityManagerSetup boolean defaultSecurityManagerSetup() Install the default security manager setup, for the current configuration. Throws: java.security.PrivilegedActionException getPassword static final java.lang.String getPassword(java.lang.String user, java.lang.String token) Get the password that is a function of the user name and the passed in token. getPassword public final java.lang.String getPassword(java.lang.String user) Get the password that is a function of the user name and the token for the current configuration. getDatabasePath public final java.lang.String getDatabasePath(java.lang.String physicalDatabaseName)

Class TestConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DBNAME

DEFAULT_DBNAME_SQL

DEFAULT_USER_NAME

DEFAULT_USER_PASSWORD

DEFAULT_PORT

DEFAULT_FRAMEWORK

DEFAULT_HOSTNAME

LOCKFILETIMEOUT

MAX_PORTS_USED

basePort

lastAssignedPort

bogusPort

assignedPortCount

serverOutput

SLEEP_TIME

KEY_DBNAME

KEY_FRAMEWORK

KEY_USER_PASSWORD

KEY_USER_NAME

KEY_HOSTNAME

KEY_PORT

KEY_VERBOSE

KEY_LOGIN_TIMEOUT

KEY_TRACE

KEY_OMIT_LUCENE

KEY_OMIT_JSON

KEY_STOP_AFTER_FIRST_FAIL

KEY_SSL

KEY_JMX_PORT

uniqueDB

releaseRepository

JUNIT_CONFIG

DEFAULT_CONFIG

CURRENT_CONFIG

defaultDbName

usedDbNames

logicalDbMapping

url

userName

userPassword

port

hostName

jdbcClient

jmxPort

isVerbose

doTrace

stopAfterFirstFail

ssl

connectionAttributes

passwordToken

connector

Constructor Detail

TestConfiguration

TestConfiguration

TestConfiguration

TestConfiguration

TestConfiguration

TestConfiguration

TestConfiguration

TestConfiguration

Method Detail

getCurrent

getReleaseRepository

setCurrent

defaultSuite

defaultSuite

defaultExistingServerSuite

defaultExistingServerSuite

existingServerSuite

existingServerSuite

forceJDBC3Suite

suiteName

embeddedSuite

clientServerSuite