oracle.ifs.admin.tools.upgrade.actions

Class JdbcAction

java.lang.Object

oracle.ifs.admin.tools.upgrade.actions.AbstractUpgradeAction

oracle.ifs.admin.tools.upgrade.actions.JdbcAction

All Implemented Interfaces:

UpgradeAction

public abstract class JdbcAction
extends AbstractUpgradeAction

Abstract class for performing JDBC operations.

JDBC connections are created using the DataSource returned by getDataSource.

The JDBC connections have auto-commit disabled. Subclasses must explicitly commit to persist changes.

This class is thread-safe when the schema upgrade is performed through the UpgradeDriverManager interface.

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
JdbcAction() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	analyze() Subclasses should override analyze(Connection).
protected void	analyze(Connection conn) Called by analyze.
protected DataSource	getDataSource() Gets the DataSource used to create the JDBC connection.
protected void	postEvent(Connection conn, long id, long classid, int eventType, int eventSubtype, long longPayload) Inserts a row into odmz_event, using the specified connection.
void	postUpgrade() Subclasses should override postUpgrade(Connection).
protected void	postUpgrade(Connection conn) Called by postUpgrade.
void	preUpgrade() Subclasses should override preUpgrade(Connection).
protected void	preUpgrade(Connection conn) Called by preUpgrade.
void	rollback(boolean downgrade) Subclasses should override rollback(Connection, boolean).
protected void	rollback(Connection conn, boolean downgrade) Called by rollback.
void	upgrade() Subclasses should override upgrade(Connection).
protected void	upgrade(Connection conn) Called by upgrade.

Methods inherited from class oracle.ifs.admin.tools.upgrade.actions.AbstractUpgradeAction

getName, getProperties, getProperty, getUpgradeActionContext, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcAction

public JdbcAction()

Default constructor.

(Unpublished)

Method Detail

analyze

public final void analyze()
                   throws IfsException

Subclasses should override analyze(Connection).

Specified by:

analyze in interface UpgradeAction

Overrides:

analyze in class AbstractUpgradeAction

Throws:

IfsException - 82101: if the operation fails

(Unpublished)

preUpgrade

public final void preUpgrade()
                      throws IfsException

Subclasses should override preUpgrade(Connection).

Specified by:

preUpgrade in interface UpgradeAction

Overrides:

preUpgrade in class AbstractUpgradeAction

Throws:

IfsException - 82102: if the operation fails

(Unpublished)

upgrade

public final void upgrade()
                   throws IfsException

Subclasses should override upgrade(Connection).

Specified by:

upgrade in interface UpgradeAction

Overrides:

upgrade in class AbstractUpgradeAction

Throws:

IfsException - 82103: if the operation fails

(Unpublished)

postUpgrade

public final void postUpgrade()
                       throws IfsException

Subclasses should override postUpgrade(Connection).

Specified by:

postUpgrade in interface UpgradeAction

Overrides:

postUpgrade in class AbstractUpgradeAction

Throws:

IfsException - 82104: if the operation fails

(Unpublished)

rollback

public final void rollback(boolean downgrade)
                    throws IfsException

Subclasses should override rollback(Connection, boolean).

Specified by:

rollback in interface UpgradeAction

Overrides:

rollback in class AbstractUpgradeAction

Parameters:

downgrade - whether the rollback is being performed as part of a downgrade

Throws:

IfsException - 82105: if the operation fails

(Unpublished)

analyze

protected void analyze(Connection conn)
                throws IfsException,
                       SQLException

Called by analyze.

Subclasses should override this method to perform the analysis phase of the upgrade action.

Parameters:

conn - the JDBC connection

Throws:

IfsException - if the operation fails

SQLException - if the operation fails

(Unpublished)

preUpgrade

protected void preUpgrade(Connection conn)
                   throws IfsException,
                          SQLException

Called by preUpgrade.

Subclasses should override this method to perform the pre-upgrade phase of the upgrade action.

Parameters:

conn - the JDBC connection

Throws:

IfsException - if the operation fails

SQLException - if the operation fails

(Unpublished)

upgrade

protected void upgrade(Connection conn)
                throws IfsException,
                       SQLException

Called by upgrade.

Subclasses should override this method to perform the upgrade phase of the upgrade action.

Parameters:

conn - the JDBC connection

Throws:

IfsException - if the operation fails

SQLException - if the operation fails

(Unpublished)

postUpgrade

protected void postUpgrade(Connection conn)
                    throws IfsException,
                           SQLException

Called by postUpgrade.

Subclasses should override this method to perform the post-upgrade phase of the upgrade action.

Parameters:

conn - the JDBC connection

Throws:

IfsException - if the operation fails

SQLException - if the operation fails

(Unpublished)

rollback

protected void rollback(Connection conn,
                        boolean downgrade)
                 throws IfsException,
                        SQLException

Called by rollback.

Subclasses should override this method to rollback the analysis and pre-upgrade phases of the upgrade action.

Parameters:

conn - the JDBC connection

downgrade - whether the rollback is being performed as part of a downgrade

Throws:

IfsException - if the operation fails

SQLException - if the operation fails

(Unpublished)

getDataSource

protected DataSource getDataSource()
                            throws IfsException

Gets the DataSource used to create the JDBC connection.

In this class, returns the DataSource for connecting to the repository. Subclasses can override this method to return a different DataSource.

Returns:

the DataSource

Throws:

IfsException - if the operation fails

(Unpublished)

postEvent

protected void postEvent(Connection conn,
                         long id,
                         long classid,
                         int eventType,
                         int eventSubtype,
                         long longPayload)
                  throws IfsException

Inserts a row into odmz_event, using the specified connection.

Parameters:

conn - the connection

id - the id

classid - the class id

eventType - the event type

eventSubtype - the event sub-type

longPayload - the event payload

Throws:

IfsException - if the operation fails

(Unpublished)