com.dpslink.base.jdbc

Class JDBCManager

java.lang.Object

com.dpslink.base.jdbc.JDBCManager

All Implemented Interfaces:

java.io.Serializable

public class JDBCManager
extends java.lang.Object
implements java.io.Serializable

The default manager for a JDBC database. Applications may wish to include a subclassed implemention of this manager in order to provide functions that are additional and unique to the application.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
JDBCManager()

Method Summary

Modifier and Type	Method and Description
static void	closeTransaction(java.sql.Connection conn, boolean commit) Closes a connection transaction and commits or rolls back any changes made to the database.
static boolean	createDatabase(java.lang.String poolName, JDBCConnectionInfo cninf) Creates the database tables and indexes and views using the definitions found in the application's resource file.
private static boolean	createDatabaseIndexes(JDBCConnectionInfo cninf) Creates the database indexes using definitions in the application's resource file.
private static boolean	createDatabaseTables(JDBCConnectionInfo cninf) Creates the database tables using definitions in the application's resource file.
private static boolean	createDatabaseViews(JDBCConnectionInfo cninf) Creates the database views using definitions in the application's resource file.
static boolean	databaseExists(JDBCConnectionInfo cninf) Determines if the database exists and if one or more tables are in the database.
static boolean	databaseRevised(JDBCConnectionInfo cninf) Determines if the database has been revised by comparing the count of tables and columns and views in the database to those defined in the application's resource file.
static java.sql.DatabaseMetaData	getDatabaseMetaData(java.sql.Connection conn) Returns the DatabaseMetaData object for the current JDBC connection.
static java.lang.String	getDatabaseVersionInfo(java.sql.Connection conn) Returns a formatted string of database and driver version information.
static java.sql.PreparedStatement	getPreparedStatement(JDBCConnectionInfo cninf, java.lang.String stmtkey) Returns an SQL PreparedStatement for the given statement resource key.
static java.sql.PreparedStatement	getPreparedStatement(JDBCConnectionInfo cninf, java.lang.String stmtkey, java.lang.String stmtstr) Returns an SQL PreparedStatement for the given statement resource key.
static java.sql.PreparedStatement	getPreparedStatementForUpdate(JDBCConnectionInfo cninf, java.lang.String stmtkey, java.lang.String stmtstr) Returns an updatable SQL PreparedStatement for the given statement resource key.
static java.sql.Statement	getStatement(java.sql.Connection conn) Returns an SQL Statement object for the active JDBC connection.
static boolean	isTransaction(java.sql.Connection conn) Answers if a connection transaction is currently open (auto commit is off).
static void	openTransaction(java.sql.Connection conn) Opens a connection transaction (sets auto commit off).
static boolean	optimizeDatabase() Performs database optimization.
static boolean	reviseDatabase(JDBCConnectionInfo cninf) Revises the database tables and columns and views using the definitions found in the application's resource file.
private static boolean	reviseDatabaseColumns(JDBCConnectionInfo cninf, java.lang.String tblname) Adds or deletes columns in a database table.
private static boolean	reviseDatabaseTables(JDBCConnectionInfo cninf, int tblcount) Adds or deletes tables in the database.
private static boolean	reviseDatabaseViews(JDBCConnectionInfo cninf) Adds or deletes views in the database.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

JDBCManager

public JDBCManager()

Method Detail

closeTransaction

public static void closeTransaction(java.sql.Connection conn,
                                    boolean commit)

Closes a connection transaction and commits or rolls back any changes made to the database.

Parameters:

conn - (Connection) The JDBC connection to use.

commit - (boolean) true if changes to the database are to be committed, otherwise false.

createDatabase

public static boolean createDatabase(java.lang.String poolName,
                                     JDBCConnectionInfo cninf)

Creates the database tables and indexes and views using the definitions found in the application's resource file.

Parameters:

poolName - (String) The JDBC pool name to use.

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

boolean - true if the database table and index and view creates are successful, otherwise false.

createDatabaseIndexes

private static boolean createDatabaseIndexes(JDBCConnectionInfo cninf)

Creates the database indexes using definitions in the application's resource file.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

boolean - true if the database index creates are successful, otherwise false.

createDatabaseTables

private static boolean createDatabaseTables(JDBCConnectionInfo cninf)

Creates the database tables using definitions in the application's resource file.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

boolean - true if the database table creates are successful, otherwise false.

createDatabaseViews

private static boolean createDatabaseViews(JDBCConnectionInfo cninf)

Creates the database views using definitions in the application's resource file.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

boolean - true if the database view creates are successful, otherwise false.

databaseExists

public static boolean databaseExists(JDBCConnectionInfo cninf)

Determines if the database exists and if one or more tables are in the database.

This method does not verify that every table and every column used by an application exists. Applications that require a more complete verification of the database should invoke databaseRevised if the result from this method is true.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

boolean - true if the database exists and tables are found in the database, otherwise false.

databaseRevised

public static boolean databaseRevised(JDBCConnectionInfo cninf)

Determines if the database has been revised by comparing the count of tables and columns and views in the database to those defined in the application's resource file.

Due to limitations in DB2e, this method does not verify indexes.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

boolean - true if the database table or column or view counts differ from what is defined the application resource file, otherwise false.

getDatabaseMetaData

public static java.sql.DatabaseMetaData getDatabaseMetaData(java.sql.Connection conn)
                                                     throws java.lang.Exception

Returns the DatabaseMetaData object for the current JDBC connection.

Parameters:

conn - (Connection) The JDBC connection to use.

Returns:

DatabaseMetaData - The current connection's meta data.

Throws:

java.lang.Exception - - if an error occurs when obtaining the meta data.

getDatabaseVersionInfo

public static java.lang.String getDatabaseVersionInfo(java.sql.Connection conn)

Returns a formatted string of database and driver version information.

Parameters:

conn - (Connection) The JDBC connection to use.

Returns:

String - The database and driver version information.

getPreparedStatement

public static java.sql.PreparedStatement getPreparedStatement(JDBCConnectionInfo cninf,
                                                              java.lang.String stmtkey)
                                                       throws java.sql.SQLException

Returns an SQL PreparedStatement for the given statement resource key.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

stmtkey - (String) The resource key for the prepared statement to retrieve.

Returns:

PreparedStatement - The SQL PreparedStatement object for the specified statement resource key.

Throws:

java.sql.SQLException - - if an error occurs while processing the result set.

getPreparedStatement

public static java.sql.PreparedStatement getPreparedStatement(JDBCConnectionInfo cninf,
                                                              java.lang.String stmtkey,
                                                              java.lang.String stmtstr)
                                                       throws java.sql.SQLException

Returns an SQL PreparedStatement for the given statement resource key.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

stmtkey - (String) The resource key for the prepared statement to retrieve.

stmtstr - (String) The sql statement string, if it is already known; otherwise an empty string.

Returns:

PreparedStatement - The SQL PreparedStatement object for the specified statement resource key.

Throws:

java.sql.SQLException - - if an error occurs while processing the result set.

getPreparedStatementForUpdate

public static java.sql.PreparedStatement getPreparedStatementForUpdate(JDBCConnectionInfo cninf,
                                                                       java.lang.String stmtkey,
                                                                       java.lang.String stmtstr)
                                                                throws java.sql.SQLException

Returns an updatable SQL PreparedStatement for the given statement resource key.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

stmtkey - (String) The resource key for the prepared statement to retrieve.

stmtstr - (String) The sql statement string, if it is already known; otherwise an empty string.

Returns:

PreparedStatement - The SQL PreparedStatement object for the specified statement resource key.

Throws:

java.sql.SQLException - - if an error occurs while processing the result set.

getStatement

public static java.sql.Statement getStatement(java.sql.Connection conn)

Returns an SQL Statement object for the active JDBC connection. The invoker of this method is expected to close the statement object when done using it.

Parameters:

conn - (Connection) The JDBC connection to use.

Returns:

Statement - An SQL Statement object.

isTransaction

public static boolean isTransaction(java.sql.Connection conn)

Answers if a connection transaction is currently open (auto commit is off).

Parameters:

conn - (Connection) The JDBC connection to use.

Returns:

boolean - true if a connection transaction exists, otherwise false.

openTransaction

public static void openTransaction(java.sql.Connection conn)

Opens a connection transaction (sets auto commit off).

Parameters:

conn - (Connection) The JDBC connection to use.

optimizeDatabase

public static boolean optimizeDatabase()

Performs database optimization.

Returns:

boolean - true if the optimization is successful, otherwise false.

reviseDatabase

public static boolean reviseDatabase(JDBCConnectionInfo cninf)

Revises the database tables and columns and views using the definitions found in the application's resource file.

Due to limitations in DB2e, this method does not revise indexes.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

boolean - true if the database table and column and view revisions are successful, otherwise false.

reviseDatabaseColumns

private static boolean reviseDatabaseColumns(JDBCConnectionInfo cninf,
                                             java.lang.String tblname)

Adds or deletes columns in a database table.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a database table.

Returns:

boolean - true if the column adds or deletes are successful, otherwise false.

reviseDatabaseTables

private static boolean reviseDatabaseTables(JDBCConnectionInfo cninf,
                                            int tblcount)

Adds or deletes tables in the database.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblcount - (int) The number of tables defined in the application's resource file.

Returns:

boolean - true if the table adds and deletes are successful, otherwise false.

reviseDatabaseViews

private static boolean reviseDatabaseViews(JDBCConnectionInfo cninf)

Adds or deletes views in the database.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

boolean - true if the view adds and deletes are successful, otherwise false.