TestHelper (Debezium Connector for Oracle 1.5.3.Final Test API)

java.lang.Object
- io.debezium.connector.oracle.util.TestHelper

```
public class TestHelper
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONNECTOR_NAME`
`static String`	`CONNECTOR_USER`
`static String`	`CONNECTOR_USER_PASS`
`static String`	`DATABASE`
`private static String`	`DATABASE_ADMIN_PREFIX`
`static String`	`DATABASE_CDB`
`private static String`	`DATABASE_PREFIX`
`static Path`	`DB_HISTORY_PATH`
`static String`	`HOST`
`private static String`	`PDB_NAME`
`static int`	`PORT`
`static String`	`SCHEMA_PASS`
`static String`	`SCHEMA_USER`
`static String`	`SERVER_NAME`
`static String`	`TYPE_LENGTH_PARAMETER_KEY` Key for schema parameter used to store a source column's type length.
`static String`	`TYPE_NAME_PARAMETER_KEY` Key for schema parameter used to store a source column's type name.
`static String`	`TYPE_SCALE_PARAMETER_KEY` Key for schema parameter used to store a source column's type scale.

Constructor Summary

Constructors
Constructor and Description

TestHelper()

Constructors
Constructor and Description
`TestHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static io.debezium.connector.oracle.OracleConnectorConfig.ConnectorAdapter`	`adapter()`
`private static Configuration.Builder`	`adminConfig()` Returns a configuration builder based on the administrator account settings.
`static io.debezium.connector.oracle.OracleConnection`	`adminConnection()` Return a connection that is suitable for performing test database changes that require an administrator role permission.
`private static JdbcConfiguration`	`adminJdbcConfig()` Returns a JdbcConfiguration for the database administrator account.
`private static io.debezium.connector.oracle.OracleConnection`	`createConnection(Configuration config, Configuration jdbcConfig, boolean autoCommit)` Create an OracleConnection.
`static Configuration.Builder`	`defaultConfig()` Returns a JdbcConfiguration that is specific and suitable for initializing the connector.
`static io.debezium.connector.oracle.OracleConnection`	`defaultConnection()` Obtain a connection using the default configuration, i.e.
`private static JdbcConfiguration`	`defaultJdbcConfig()` Returns a JdbcConfiguration that is specific for the XStream/LogMiner user accounts.
`static int`	`defaultMessageConsumerPollTimeout()`
`static void`	`dropTable(io.debezium.connector.oracle.OracleConnection connection, String table)`
`static void`	`forceFlushOfRedoLogsToArchiveLogs()`
`static void`	`forceLogfileSwitch()`
`static String`	`getConnectorUserName()` Get the name of the connector user, the default is `CONNECTOR_USER`.
`private static String`	`getConnectorUserPassword()` Get the password of the connector user, the default is `CONNECTOR_USER_PASS`.
`private static Configuration`	`getDatabaseConfig(String prefix)` Retrieves all settings provided by system properties based on the supplied `prefix`.
`static String`	`getDatabaseName()` Get the database name, the default is `DATABASE`.
`static int`	`getNumberOfOnlineLogGroups()`
`static void`	`purgeRecycleBin(io.debezium.connector.oracle.OracleConnection connection)` Clear the recycle bin, removing all objects from the bin and release all space associated with objects in the recycle bin.
`static void`	`streamTable(io.debezium.connector.oracle.OracleConnection connection, String table)` Enables a given table to be streamed by Oracle.
`private static Configuration.Builder`	`testConfig()` Returns a configuration builder based on the test schema and user account settings.
`static io.debezium.connector.oracle.OracleConnection`	`testConnection()` Return a test connection that is suitable for performing test database changes in tests.
`private static JdbcConfiguration`	`testJdbcConfig()` Returns a JdbcConfiguration for the test schema and user account.

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

- Field Detail
  - PDB_NAME
```
private static final String PDB_NAME
```
    See Also:
    
    Constant Field Values
  - DATABASE_PREFIX
```
private static final String DATABASE_PREFIX
```
    See Also:
    
    Constant Field Values
  - DATABASE_ADMIN_PREFIX
```
private static final String DATABASE_ADMIN_PREFIX
```
    See Also:
    
    Constant Field Values
  - DB_HISTORY_PATH
```
public static final Path DB_HISTORY_PATH
```
  - CONNECTOR_USER
```
public static final String CONNECTOR_USER
```
    See Also:
    
    Constant Field Values
  - CONNECTOR_NAME
```
public static final String CONNECTOR_NAME
```
    See Also:
    
    Constant Field Values
  - SERVER_NAME
```
public static final String SERVER_NAME
```
    See Also:
    
    Constant Field Values
  - CONNECTOR_USER_PASS
```
public static final String CONNECTOR_USER_PASS
```
    See Also:
    
    Constant Field Values
  - HOST
```
public static final String HOST
```
    See Also:
    
    Constant Field Values
  - SCHEMA_USER
```
public static final String SCHEMA_USER
```
    See Also:
    
    Constant Field Values
  - SCHEMA_PASS
```
public static final String SCHEMA_PASS
```
    See Also:
    
    Constant Field Values
  - DATABASE
```
public static final String DATABASE
```
    See Also:
    
    Constant Field Values
  - DATABASE_CDB
```
public static final String DATABASE_CDB
```
    See Also:
    
    Constant Field Values
  - PORT
```
public static final int PORT
```
    See Also:
    
    Constant Field Values
  - TYPE_NAME_PARAMETER_KEY
```
public static final String TYPE_NAME_PARAMETER_KEY
```
    Key for schema parameter used to store a source column's type name.
    
    See Also:
    
    Constant Field Values
  - TYPE_LENGTH_PARAMETER_KEY
```
public static final String TYPE_LENGTH_PARAMETER_KEY
```
    Key for schema parameter used to store a source column's type length.
    
    See Also:
    
    Constant Field Values
  - TYPE_SCALE_PARAMETER_KEY
```
public static final String TYPE_SCALE_PARAMETER_KEY
```
    Key for schema parameter used to store a source column's type scale.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TestHelper
```
public TestHelper()
```
- Method Detail
  - getConnectorUserName
```
public static String getConnectorUserName()
```
    Get the name of the connector user, the default is CONNECTOR_USER.
  - getConnectorUserPassword
```
private static String getConnectorUserPassword()
```
    Get the password of the connector user, the default is CONNECTOR_USER_PASS.
  - getDatabaseName
```
public static String getDatabaseName()
```
    Get the database name, the default is DATABASE.
  - defaultJdbcConfig
```
private static JdbcConfiguration defaultJdbcConfig()
```
    Returns a JdbcConfiguration that is specific for the XStream/LogMiner user accounts. If connecting to a CDB enabled database, this connection is to the root database.
  - defaultConfig
```
public static Configuration.Builder defaultConfig()
```
    Returns a JdbcConfiguration that is specific and suitable for initializing the connector. The returned builder can be amended with values as a test case requires. When initializing a connector connection to a database that operates in non-CDB mode, the configuration should still provide a database.pdb.name setting; however the value of the setting should be empty. This is specific to the test suite only.
  - defaultConnection
```
public static io.debezium.connector.oracle.OracleConnection defaultConnection()
```
    Obtain a connection using the default configuration, i.e. within the context of the actual connector user that connectors and interacts with the database.
  - testJdbcConfig
```
private static JdbcConfiguration testJdbcConfig()
```
    Returns a JdbcConfiguration for the test schema and user account.
  - adminJdbcConfig
```
private static JdbcConfiguration adminJdbcConfig()
```
    Returns a JdbcConfiguration for the database administrator account.
  - testConfig
```
private static Configuration.Builder testConfig()
```
    Returns a configuration builder based on the test schema and user account settings.
  - adminConfig
```
private static Configuration.Builder adminConfig()
```
    Returns a configuration builder based on the administrator account settings.
  - getDatabaseConfig
```
private static Configuration getDatabaseConfig(String prefix)
```
    Retrieves all settings provided by system properties based on the supplied prefix.
    
    Parameters:
    
    prefix - the key prefix to limit the settings based upon, i.e. database..
    
    Returns:
    
    the configuration object
  - testConnection
```
public static io.debezium.connector.oracle.OracleConnection testConnection()
```
    Return a test connection that is suitable for performing test database changes in tests.
  - adminConnection
```
public static io.debezium.connector.oracle.OracleConnection adminConnection()
```
    Return a connection that is suitable for performing test database changes that require an administrator role permission.
  - createConnection
```
private static io.debezium.connector.oracle.OracleConnection createConnection(Configuration config,
                                                                              Configuration jdbcConfig,
                                                                              boolean autoCommit)
```
    Create an OracleConnection.
    
    Parameters:
    
    config - the connector configuration
    
    jdbcConfig - the JDBC configuration
    
    autoCommit - whether the connection should enforce auto-commit
    
    Returns:
    
    the connection
  - forceLogfileSwitch
```
public static void forceLogfileSwitch()
```
  - getNumberOfOnlineLogGroups
```
public static int getNumberOfOnlineLogGroups()
```
  - forceFlushOfRedoLogsToArchiveLogs
```
public static void forceFlushOfRedoLogsToArchiveLogs()
```
  - dropTable
```
public static void dropTable(io.debezium.connector.oracle.OracleConnection connection,
                             String table)
```
  - streamTable
```
public static void streamTable(io.debezium.connector.oracle.OracleConnection connection,
                               String table)
                        throws SQLException
```
    Enables a given table to be streamed by Oracle.
    
    Parameters:
    
    connection - the oracle connection
    
    table - the table name in schema.table format.
    
    Throws:
    
    SQLException - if an exception occurred
  - purgeRecycleBin
```
public static void purgeRecycleBin(io.debezium.connector.oracle.OracleConnection connection)
```
    Clear the recycle bin, removing all objects from the bin and release all space associated with objects in the recycle bin. This also clears any system-generated objects that are associated with a table that may have been recently dropped, such as index-organized tables.
    
    Parameters:
    
    connection - the oracle connection
  - defaultMessageConsumerPollTimeout
```
public static int defaultMessageConsumerPollTimeout()
```
  - adapter
```
public static io.debezium.connector.oracle.OracleConnectorConfig.ConnectorAdapter adapter()
```

Class TestHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PDB_NAME

DATABASE_PREFIX

DATABASE_ADMIN_PREFIX

DB_HISTORY_PATH

CONNECTOR_USER

CONNECTOR_NAME

SERVER_NAME

CONNECTOR_USER_PASS

HOST

SCHEMA_USER

SCHEMA_PASS

DATABASE

DATABASE_CDB

PORT

TYPE_NAME_PARAMETER_KEY

TYPE_LENGTH_PARAMETER_KEY

TYPE_SCALE_PARAMETER_KEY

Constructor Detail

TestHelper

Method Detail

getConnectorUserName

getConnectorUserPassword

getDatabaseName

defaultJdbcConfig

defaultConfig

defaultConnection

testJdbcConfig

adminJdbcConfig

testConfig

adminConfig

getDatabaseConfig

testConnection

adminConnection

createConnection

forceLogfileSwitch

getNumberOfOnlineLogGroups

forceFlushOfRedoLogsToArchiveLogs

dropTable

streamTable

purgeRecycleBin

defaultMessageConsumerPollTimeout

adapter