oracle.ifs.admin.upgrade.common

Class CreateDatabaseObjectsAction

java.lang.Object

oracle.ifs.utils.action.AbstractAction

oracle.ifs.admin.actions.JDBCAction

oracle.ifs.admin.upgrade.common.CreateDatabaseObjectsAction

All Implemented Interfaces:

Action, IfsParameters

Direct Known Subclasses:

AlterIfsCredentialManager, PrepareAttributeColumns

public abstract class CreateDatabaseObjectsAction
extends JDBCAction

CreateDatabaseObjectsAction is an abstract subclass of JDBCAction, which facilitates common SQL operations of creating and dropping tables, indexes, and sequences. It also provides a default implementation for stop() and failed().

(Unpublished)

Field Summary

Fields inherited from class oracle.ifs.admin.actions.JDBCAction

NOLOG

Fields inherited from class oracle.ifs.utils.action.AbstractAction

CONTINUE_ON_ERROR, m_defaultOptions, m_options

Fields inherited from interface oracle.ifs.utils.common.IfsParameters

APPEND_LOG, DATABASE_TYPE, DATABASE_URL, DB_USER_NAME, DB_USER_PASSWORD, DOMAIN_TYPE, ENABLE_SSL_SUPPORT, FOR_SCHEMA_UPGRADE, IFS_DOMAIN_DISPLAY_NAME, IFS_DOMAIN_NAME, IFS_SCHEMA_NAME, IFS_SCHEMA_PASSWORD, IFS_SERVICE_NAME, IFS_USER_NAME, IFS_USER_PASSWORD, INCLUDE_PATH, INITIAL_CONTEXT_FACTORY, LDAP_URL_DAS_LOOKUP, LDAP_USER_NAME, LDAP_USER_PASSWORD, OUTPUT_FILE, PARAMETER_FILE, REGISTRY, SCHEMA_VERSION_KEY, SECURITY_PROTOCOL_NAME, SERVICE_CONFIGURATION_NAME

Constructor Summary

Constructors

Constructor and Description
CreateDatabaseObjectsAction()

Method Summary

Modifier and Type	Method and Description
protected void	analyze(Connection conn, String schemaName) Analyze a schema.
protected void	analyzeTable(Connection conn, String schemaName, String tableName) Analyze a table in a schema.
protected void	closeResultSet(ResultSet rset) Close a ResultSet, ignoring any errors.
protected void	closeStatement(Statement stmt) Close a Statement, ignoring any errors.
protected boolean	columnExists(Connection conn, String tableName, String columnName) Return true if the specified column exists in the specified table.
protected void	commit(Connection conn) Issue a commit
protected void	createIndex(Connection conn, String indexName, String tableName, String[] columns, boolean isUnique) Create an index on n columns of a table.
protected void	createIndex(Connection conn, String indexName, String tableName, String[] columns, boolean isUnique, boolean dropAndRetryIfExists, boolean ignoreIfEquivalent) Create an index on n columns of a table.
protected void	createIndex(Connection conn, String indexName, String tableName, String columnName, boolean isUnique) Create an index on a column of a table.
protected void	createIndex(Connection conn, String indexName, String tableName, String columnName, boolean isUnique, boolean dropAndRetryIfExists, boolean ignoreIfEquivalent) Create an index on a column of a table.
protected void	createIndex(Connection conn, String indexName, String tableName, String columnName1, String columnName2, boolean isUnique) Create an index on 2 columns of a table.
protected void	createIndex(Connection conn, String indexName, String tableName, String columnName1, String columnName2, boolean isUnique, boolean dropAndRetryIfExists, boolean ignoreIfEquivalent) Create an index on 2 columns of a table.
protected void	createSequence(Connection conn, String seqName, int initialValue, int cacheSize) Create a sequence.
protected void	createTable(Connection conn, String tableName, String createStmt) Create a table.
protected void	createView(Connection conn, String viewName, String createStmt) Create a view.
protected void	dropIndex(Connection conn, String indexName) Drop an index
protected void	dropSequence(Connection conn, String seqName) Drop a sequence
protected void	dropTable(Connection conn, String tableName) Drop a table.
protected void	dropView(Connection conn, String viewName) Drop a view.
protected void	executeStatement(Connection conn, String stmtString) Execute any SQL statement
protected int	executeUpdate(Connection conn, String stmtString) Execute an update statement.
void	failed(Throwable error) Does nothing.
protected long	getNextSequenceValue(Connection conn, String seqName) Get a value from a sequence.
String	getSchemaName() Gets the schema name.
protected String	getTimestamp() Gets a timestamp to use in the logs.
protected boolean	isValidConnection(Connection conn) Test validity of a Connection
protected void	log(String msg) Add message to the log.
protected void	log(Throwable t) Add message to the log.
protected void	printStackTrace(Throwable e) Add stacktrace to the log.
protected void	rollback(Connection conn) Issue a rollback
protected boolean	rowExists(Connection conn, String tableName, String condition) Return true if there is a row that meets the specified condition for the specified table.
protected boolean	rowExists(Connection conn, String tableName, String condition, boolean errorValue) Return true if there is a row that meets the specified condition for the specified table.
void	stop() Does nothing.
protected boolean	tableExists(Connection conn, String tableName) Return true if the specified table exists.

Methods inherited from class oracle.ifs.admin.actions.JDBCAction

execute, perform, setDatabaseUrl, setPassword, setUser

Methods inherited from class oracle.ifs.utils.action.AbstractAction

getDescription, getName, getValue, isContinueOnError, isPostgres, putValue, setDefaultOptions, setDescription, setName, setOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateDatabaseObjectsAction

public CreateDatabaseObjectsAction()

Method Detail

stop

public void stop()

Does nothing.

failed

public void failed(Throwable error)

Does nothing.

Parameters:

error - the error that occurred.

getSchemaName

public String getSchemaName()

Gets the schema name.

Returns:

the schema name

(Unpublished)

createTable

protected void createTable(Connection conn,
                           String tableName,
                           String createStmt)
                    throws SQLException

Create a table.

Parameters:

conn - the database connection

tableName - the name of the table

createStmt - the CREATE TABLE sql string

Throws:

SQLException - if the operation fails

(Unpublished)

createView

protected void createView(Connection conn,
                          String viewName,
                          String createStmt)
                   throws SQLException

Create a view.

Parameters:

conn - the database connection

viewName - the name of the view

createStmt - the CREATE VIEW sql string

Throws:

SQLException - if the operation fails

(Unpublished)

dropTable

protected void dropTable(Connection conn,
                         String tableName)
                  throws SQLException

Drop a table. Does not throw an exception if the attempt fails.

Parameters:

conn - the database connection

tableName - the name of the table

Throws:

SQLException - if the operation fails

(Unpublished)

dropView

protected void dropView(Connection conn,
                        String viewName)
                 throws SQLException

Drop a view. Does not throw an exception if the attempt fails.

Parameters:

conn - the database connection

viewName - the name of the table

Throws:

SQLException - if the operation fails

(Unpublished)

createIndex

protected void createIndex(Connection conn,
                           String indexName,
                           String tableName,
                           String columnName,
                           boolean isUnique)
                    throws SQLException

Create an index on a column of a table. If the index name is in use, it will be dropped and the creation will be retried. If an equivalent index exists for the column specified, the specified index will not be created, and no exception will be thrown.

Parameters:

conn - the database connection

indexName - the name of the index

tableName - the name of the table

columnName - the name of the column

isUnique - is the index to be a unique index?

Throws:

SQLException - if the operation fails

(Unpublished)

createIndex

protected void createIndex(Connection conn,
                           String indexName,
                           String tableName,
                           String columnName,
                           boolean isUnique,
                           boolean dropAndRetryIfExists,
                           boolean ignoreIfEquivalent)
                    throws SQLException

Create an index on a column of a table.

Parameters:

conn - the database connection

indexName - the name of the index

tableName - the name of the table

columnName - the name of the column

isUnique - is the index to be a unique index?

dropAndRetryIfExists - if index name exists, should it be dropped and creation retried?

ignoreIfEquivalent - if another index exists on the specified columns, should the exception be ignored?

Throws:

SQLException - if the operation fails

(Unpublished)

createIndex

protected void createIndex(Connection conn,
                           String indexName,
                           String tableName,
                           String columnName1,
                           String columnName2,
                           boolean isUnique)
                    throws SQLException

Create an index on 2 columns of a table. If the index name is in use, it will be dropped and the creation will be retried. If an equivalent index exists for the columns specified, the specified index will not be created, and no exception will be thrown.

Parameters:

conn - the database connection

indexName - the name of the index

tableName - the name of the table

columnName1 - the name of the first column

columnName2 - the name of the second column

isUnique - is the index to be a unique index?

Throws:

SQLException - if the operation fails

(Unpublished)

createIndex

protected void createIndex(Connection conn,
                           String indexName,
                           String tableName,
                           String columnName1,
                           String columnName2,
                           boolean isUnique,
                           boolean dropAndRetryIfExists,
                           boolean ignoreIfEquivalent)
                    throws SQLException

Create an index on 2 columns of a table.

Parameters:

conn - the database connection

indexName - the name of the index

tableName - the name of the table

columnName1 - the name of the first column

columnName2 - the name of the second column

isUnique - is the index to be a unique index?

dropAndRetryIfExists - if index name exists, should it be dropped and creation retried?

ignoreIfEquivalent - if another index exists on the specified columns, should the exception be ignored?

Throws:

SQLException - if the operation fails

(Unpublished)

createIndex

protected void createIndex(Connection conn,
                           String indexName,
                           String tableName,
                           String[] columns,
                           boolean isUnique)
                    throws SQLException

Create an index on n columns of a table. If the index name is in use, it will be dropped and the creation will be retried. If an equivalent index exists for the columns specified, the specified index will not be created, and no exception will be thrown.

Parameters:

conn - the database connection

indexName - the name of the index

tableName - the name of the table

columns - the names of the columns

isUnique - is the index to be a unique index?

Throws:

SQLException - if the operation fails

(Unpublished)

createIndex

protected void createIndex(Connection conn,
                           String indexName,
                           String tableName,
                           String[] columns,
                           boolean isUnique,
                           boolean dropAndRetryIfExists,
                           boolean ignoreIfEquivalent)
                    throws SQLException

Create an index on n columns of a table.

Parameters:

conn - the database connection

indexName - the name of the index

tableName - the name of the table

columns - the names of the columns

isUnique - is the index to be a unique index?

dropAndRetryIfExists - if index name exists, should it be dropped and creation retried?

ignoreIfEquivalent - if another index exists on the specified columns, should the exception be ignored?

Throws:

SQLException - if the operation fails

(Unpublished)

dropIndex

protected void dropIndex(Connection conn,
                         String indexName)
                  throws SQLException

Drop an index

Parameters:

conn - the database connection

indexName - the name of the index

Throws:

SQLException - if the operation fails

(Unpublished)

createSequence

protected void createSequence(Connection conn,
                              String seqName,
                              int initialValue,
                              int cacheSize)
                       throws SQLException

Create a sequence. Assumes a few defaults: INCREMENT BY 1 NOMAXVALUE NOCYCLE

Parameters:

conn - the database connection

seqName - the name of the seqeunce

initialValue - the initial value

cacheSize - the cache size

Throws:

SQLException - if the operation fails

(Unpublished)

dropSequence

protected void dropSequence(Connection conn,
                            String seqName)
                     throws SQLException

Drop a sequence

Parameters:

conn - the database connection

seqName - the name of the seqeunce

Throws:

SQLException - if the operation fails

(Unpublished)

getNextSequenceValue

protected long getNextSequenceValue(Connection conn,
                                    String seqName)
                             throws SQLException

Get a value from a sequence. Throws if the sequence does not exist.

Parameters:

conn - the database connection

seqName - the sequence

Returns:

the next sequence value

Throws:

SQLException - if the operation fails

(Unpublished)

executeStatement

protected void executeStatement(Connection conn,
                                String stmtString)
                         throws SQLException

Execute any SQL statement

Parameters:

conn - the database connection

stmtString - the SQL to execute

Throws:

SQLException - if the operation fails

(Unpublished)

executeUpdate

protected int executeUpdate(Connection conn,
                            String stmtString)
                     throws SQLException

Execute an update statement. Returns the number of rows affected by the update.

Parameters:

conn - the database connection

stmtString - the SQL to execute

Throws:

SQLException - if the operation fails

(Unpublished)

rowExists

protected boolean rowExists(Connection conn,
                            String tableName,
                            String condition)
                     throws SQLException

Return true if there is a row that meets the specified condition for the specified table. Throws if the table does not exist.

Parameters:

conn - the database connection

tableName - the table name

condition - the where clause

Throws:

SQLException - if the operation fails

(Unpublished)

rowExists

protected boolean rowExists(Connection conn,
                            String tableName,
                            String condition,
                            boolean errorValue)

Return true if there is a row that meets the specified condition for the specified table. Return the specified "error" value if a SQL error occurs.

Parameters:

conn - the database connection

tableName - the table name

condition - the where clause

errorValue - the value to return if the SQL fails

Throws:

SQLException - if the operation fails

(Unpublished)

tableExists

protected boolean tableExists(Connection conn,
                              String tableName)
                       throws SQLException

Return true if the specified table exists.

Parameters:

conn - the database connection

tableName - the table name

Returns:

true if the table exists

Throws:

SQLException - if the operation fails

(Unpublished)

columnExists

protected boolean columnExists(Connection conn,
                               String tableName,
                               String columnName)
                        throws SQLException

Return true if the specified column exists in the specified table.

Parameters:

conn - the database connection

tableName - the table name

columnName - the column name

Returns:

true if the column exists

Throws:

SQLException - if the operation fails

(Unpublished)

analyze

protected void analyze(Connection conn,
                       String schemaName)
                throws SQLException

Analyze a schema.

Parameters:

conn - the database connection

schemaName - the name of the schema to analyze

Throws:

SQLException - if the operation fails

(Unpublished)

analyzeTable

protected void analyzeTable(Connection conn,
                            String schemaName,
                            String tableName)
                     throws SQLException

Analyze a table in a schema.

Parameters:

conn - the database connection

schemaName - the name of the schema containing the table

tableName - the name of the table to analyze

Throws:

SQLException - if the operation fails

(Unpublished)

commit

protected void commit(Connection conn)
               throws SQLException

Issue a commit

Parameters:

conn - the database connection

Throws:

SQLException - if the operation fails

(Unpublished)

rollback

protected void rollback(Connection conn)
                 throws SQLException

Issue a rollback

Parameters:

conn - the database connection

Throws:

SQLException - if the operation fails

(Unpublished)

isValidConnection

protected boolean isValidConnection(Connection conn)

Test validity of a Connection

Parameters:

conn - the database connection

Returns:

true iff the connection is valid

(Unpublished)

closeResultSet

protected void closeResultSet(ResultSet rset)

Close a ResultSet, ignoring any errors.

Parameters:

rset - the ResultSet to close

(Unpublished)

closeStatement

protected void closeStatement(Statement stmt)

Close a Statement, ignoring any errors.

Parameters:

stmt - the statement to close

(Unpublished)

log

protected void log(String msg)

Add message to the log.

Parameters:

msg - the message to log

(Unpublished)

log

protected void log(Throwable t)

Add message to the log.

Parameters:

t - the throwable to log

(Unpublished)

printStackTrace

protected void printStackTrace(Throwable e)

Add stacktrace to the log.

Parameters:

e - the Throwable to log

(Unpublished)

getTimestamp

protected String getTimestamp()

Gets a timestamp to use in the logs.

Returns:

a timestamp for the current time

(Unpublished)