org.apache.james.util.sql

Class JDBCUtil

java.lang.Object

org.apache.james.util.sql.JDBCUtil

public abstract class JDBCUtil
extends Object

Helper class for managing common JDBC tasks.

This class is abstract to allow implementations to take advantage of different logging capabilities/interfaces in different parts of the code.

Constructor Summary

Constructors

Constructor and Description
JDBCUtil()

Method Summary

Methods

Modifier and Type	Method and Description
void	closeJDBCConnection(Connection conn) Closes database connection and logs if an error is encountered
void	closeJDBCResultSet(ResultSet aResultSet) Closes database result set and logs if an error is encountered
void	closeJDBCStatement(Statement stmt) Closes database statement and logs if an error is encountered
boolean	columnExists(DatabaseMetaData dbMetaData, String tableName, String columnName) Checks database metadata to see if a column exists in a table.
boolean	columnExistsCaseSensitive(DatabaseMetaData dbMetaData, String tableName, String columnName) Checks database metadata to see if a column exists in a table.
protected abstract void	delegatedLog(String errorString) An abstract method which child classes override to handle logging of errors in their particular environments.
boolean	tableExists(DatabaseMetaData dbMetaData, String tableName) Checks database metadata to see if a table exists.
boolean	tableExistsCaseSensitive(DatabaseMetaData dbMetaData, String tableName) Checks database metadata to see if a table exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCUtil

public JDBCUtil()

Method Detail

delegatedLog

protected abstract void delegatedLog(String errorString)

An abstract method which child classes override to handle logging of errors in their particular environments.

Parameters:

errorString - the error message generated

tableExists

public boolean tableExists(DatabaseMetaData dbMetaData,
                  String tableName)
                    throws SQLException

Checks database metadata to see if a table exists. Try UPPER, lower, and MixedCase, to see if the table is there.

Parameters:

dbMetaData - the database metadata to be used to look up this table

tableName - the table name

Throws:

SQLException - if an exception is encountered while accessing the database

tableExistsCaseSensitive

public boolean tableExistsCaseSensitive(DatabaseMetaData dbMetaData,
                               String tableName)
                                 throws SQLException

Checks database metadata to see if a table exists. This method is sensitive to the case of the provided table name.

Parameters:

dbMetaData - the database metadata to be used to look up this table

tableName - the case sensitive table name

Throws:

SQLException - if an exception is encountered while accessing the database

columnExists

public boolean columnExists(DatabaseMetaData dbMetaData,
                   String tableName,
                   String columnName)
                     throws SQLException

Checks database metadata to see if a column exists in a table. Try UPPER, lower, and MixedCase, both on the table name and the column name, to see if the column is there.

Parameters:

dbMetaData - the database metadata to be used to look up this column

tableName - the table name

columnName - the column name

Throws:

SQLException - if an exception is encountered while accessing the database

columnExistsCaseSensitive

public boolean columnExistsCaseSensitive(DatabaseMetaData dbMetaData,
                                String tableName,
                                String columnName)
                                  throws SQLException

Checks database metadata to see if a column exists in a table. This method is sensitive to the case of both the provided table name and column name.

Parameters:

dbMetaData - the database metadata to be used to look up this column

tableName - the case sensitive table name

columnName - the case sensitive column name

Throws:

SQLException - if an exception is encountered while accessing the database

closeJDBCConnection

public void closeJDBCConnection(Connection conn)

Closes database connection and logs if an error is encountered

Parameters:

conn - the connection to be closed

closeJDBCStatement

public void closeJDBCStatement(Statement stmt)

Closes database statement and logs if an error is encountered

Parameters:

stmt - the statement to be closed

closeJDBCResultSet

public void closeJDBCResultSet(ResultSet aResultSet)

Closes database result set and logs if an error is encountered

Parameters:

aResultSet - the result set to be closed