oracle.ifs.admin.actions

Class JDBCAction

java.lang.Object

oracle.ifs.utils.action.AbstractAction

oracle.ifs.admin.actions.JDBCAction

All Implemented Interfaces:

Action, IfsParameters

Direct Known Subclasses:

AlterPasswordAction, CreateDatabaseObjectsAction, CreateIfsCredentialManagerSchemaAction, CreateIfsSchemaAction, DropLykeIndexAction, DropNamedSchemaAction, DropSchemasAction, SetRepositoryParameterAction, SetSchemaVersionAction, UpdateUpgradeStatusAction

public abstract class JDBCAction
extends AbstractAction
implements IfsParameters

The JDBCAction class is an Action implementation for executing JDBC statements. JDBCAction uses four options:
jdbc.user.name
jdbc.user.password
jdbc.database.url
nolog

Author:

Luis Saenz

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOLOG Option key "nolog" when "true" means not to establish a connection.

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
JDBCAction() Creates a new JDBCAction without specifying database credentials.
JDBCAction(String user, String password, String url) Creates a new JDBCAction.

Method Summary

Modifier and Type	Method and Description
abstract void	execute(Connection con) Executes JDBC statements.
void	perform() Performs this JDBCAction.
void	setDatabaseUrl(String url) Sets the database URL to use when connecting.
void	setPassword(String password) Sets the database user password.
void	setUser(String user) Sets the the database user (schema) name to connect as.

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

Methods inherited from interface oracle.ifs.utils.action.Action

failed, stop

Field Detail

NOLOG

public static final String NOLOG

Option key "nolog" when "true" means not to establish a connection. This can be used when user wants to run a sql file which has connect statement within the file and thus at command line they specify "sqlplus /nolog" Defined as "nolog".

See Also:

Constant Field Values

Constructor Detail

JDBCAction

public JDBCAction()

Creates a new JDBCAction without specifying database credentials.

JDBCAction

public JDBCAction(String user,
                  String password,
                  String url)

Creates a new JDBCAction.

Parameters:

user - the database user (schema) name to connect as.

password - the database user's password.

url - the database URL to use when connecting.

Method Detail

setUser

public void setUser(String user)

Sets the the database user (schema) name to connect as.

Parameters:

user - the database user (schema) name to connect as.

setPassword

public void setPassword(String password)

Sets the database user password.

Parameters:

password - the database user's password.

setDatabaseUrl

public void setDatabaseUrl(String url)

Sets the database URL to use when connecting.

Parameters:

url - the database URL to use when connecting.

perform

public void perform()
             throws ActionFailedException

Performs this JDBCAction.

Opens a JDBC Connection to the specified database, invokes the execute method, passing it the Connection, and closes the Connection when the execute method returns.

Specified by:

perform in interface Action

Throws:

ActionFailedException - if this Action fails.

execute

public abstract void execute(Connection con)
                      throws SQLException,
                             ActionFailedException

Executes JDBC statements.

Note: Subclasses should provide an implementation for this method.

The Connection does not need to be closed by this method; the calling method will close it. However, any Statement or ResultSet objects that are opened should be closed explicitly.

Parameters:

con - the Connection to the database.

Throws:

SQLException - if a database error occurs.

ActionFailedException - if any other error occurs.