com.gargoylesoftware.base.resource.jdbc

Class ConnectionWrapper

java.lang.Object

com.gargoylesoftware.base.resource.jdbc.ConnectionWrapper

All Implemented Interfaces:

ManagedResource, AutoCloseable, Connection, Wrapper

public final class ConnectionWrapper
extends Object
implements Connection, ManagedResource

A wrapper for java.sql.Connection objects.

The contract with JDBC says that result sets must be closed before statements and statements must be closed before connections but java does not enforce this contract. It is quite possible to close a connection while statements and result sets are still open. While some database drivers handle this condition nicely, others will start failing in undefined ways when this happens.

This wrapper class is a solution to this problem. If the connection is only accessed through the wrapper then the wrapper will ensure that everything is closed in the correct order. It will also ensure that the various jdbc objects (connections, statements, result sets and metadata) cannot be used after they are closed.

This class was created for the JDBCResourceFactory but can be used by itself.

Version:

$Revision: 1.4 $

Author:

Mike Bowler

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor and Description
ConnectionWrapper(Connection connection) Create a new connection wrapper

Method Summary

Modifier and Type	Method and Description
void	abort(Executor executor)
void	clearWarnings() Clears all warnings reported for this Connection object.
void	close() Releases a Connection's database and JDBC resources immediately instead of waiting for them to be automatically released.
void	closeAnyOpenMetaDatas() Close any open DatabaseMetaData objects
void	closeAnyOpenStatements() Close any open statements
void	commit() Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection.
Array	createArrayOf(String typeName, Object[] elements)
Blob	createBlob()
Clob	createClob()
NClob	createNClob()
SQLXML	createSQLXML()
Statement	createStatement() Creates a Statement object for sending SQL statements to the database.
Statement	createStatement(int resultSetType, int resultSetConcurrency) Creates a Statement object that will generate ResultSet objects with the given type and concurrency.
Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
Struct	createStruct(String typeName, Object[] attributes)
boolean	getAutoCommit() Gets the current auto-commit state.
String	getCatalog() Returns the Connection's current catalog name.
Properties	getClientInfo()
String	getClientInfo(String name)
Connection	getDelegate() Return the wrapped connection
int	getHoldability() Retrieves the current holdability of ResultSet objects created using this Connection object.
DatabaseMetaData	getMetaData() Gets the metadata regarding this connection's database.
int	getNetworkTimeout()
int	getOpenStatementCount() Return the number of statements that are currently open.
String	getResourceFactoryName() Return the name of the factory that allocated this connection
String	getSchema()
int	getTransactionIsolation() Gets this Connection's current transaction isolation level.
Map	getTypeMap() Gets the type map object associated with this connection.
SQLWarning	getWarnings() Returns the first warning reported by calls on this Connection.
boolean	isClosed() Tests to see if a Connection is closed.
boolean	isReadOnly() Tests to see if the connection is in read-only mode.
boolean	isValid(int timeout)
boolean	isWrapperFor(Class<?> iface)
String	nativeSQL(String sql) Converts the given SQL statement into the system's native SQL grammar.
CallableStatement	prepareCall(String sql) Creates a CallableStatement object for calling database stored procedures.
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency) Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
PreparedStatement	prepareStatement(String sql) Creates a PreparedStatement object for sending parameterized SQL statements to the database.
PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys) Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
PreparedStatement	prepareStatement(String sql, int[] columnIndexes) Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency) Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
PreparedStatement	prepareStatement(String sql, String[] columnNames) Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
void	releaseSavepoint(Savepoint savepoint) Removes the given Savepoint object from the current transaction.
void	rollback() Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection.
void	rollback(Savepoint savepoint) Undoes all changes made after the given Savepoint object was set.
void	setAutoCommit(boolean autoCommit) Sets this connection's auto-commit mode.
void	setCatalog(String catalog) Sets a catalog name in order to select a subspace of this Connection's database in which to work.
void	setClientInfo(Properties properties)
void	setClientInfo(String name, String value)
void	setHoldability(int holdability) Changes the holdability of ResultSet objects created using this Connection object to the given holdability.
void	setNetworkTimeout(Executor executor, int timeout)
void	setReadOnly(boolean readOnly) Puts this connection in read-only mode as a hint to enable database optimizations.
void	setResourceFactoryName(String name) Set the name of the factory that allocated this connection
Savepoint	setSavepoint() Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
Savepoint	setSavepoint(String name) Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
void	setSchema(String schema)
void	setTransactionIsolation(int level) Attempts to change the transaction isolation level to the one given.
void	setTypeMap(Map map) Installs the given type map as the type map for this connection.
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionWrapper

public ConnectionWrapper(Connection connection)

Create a new connection wrapper

Parameters:

connection - The connection that we are wrapping

Method Detail

setResourceFactoryName

public final void setResourceFactoryName(String name)

Set the name of the factory that allocated this connection

Specified by:

setResourceFactoryName in interface ManagedResource

Parameters:

name - The name of the factory

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException

Sets this connection's auto-commit mode. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode.

The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet, the statement completes when the last row of the ResultSet has been retrieved or the ResultSet has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. In these cases the commit occurs when all results and output parameter values have been retrieved.

Specified by:

setAutoCommit in interface Connection

Parameters:

autoCommit - true enables auto-commit; false disables auto-commit.

Throws:

SQLException - if a database access error occurs

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

Puts this connection in read-only mode as a hint to enable database optimizations.

Note: This method cannot be called while in the middle of a transaction.

Specified by:

setReadOnly in interface Connection

Parameters:

readOnly - true enables read-only mode; false disables read-only mode.

Throws:

SQLException - if a database access error occurs

setCatalog

public void setCatalog(String catalog)
                throws SQLException

Sets a catalog name in order to select a subspace of this Connection's database in which to work. If the driver does not support catalogs, it will silently ignore this request.

Specified by:

setCatalog in interface Connection

Parameters:

catalog - The catalog name

Throws:

SQLException - if a database access error occurs

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Attempts to change the transaction isolation level to the one given. The constants defined in the interface Connection are the possible transaction isolation levels.

Note: This method cannot be called while in the middle of a transaction.

Specified by:

setTransactionIsolation in interface Connection

Parameters:

level - one of the TRANSACTION_* isolation values with the exception of TRANSACTION_NONE; some databases may not support other values

Throws:

SQLException - if a database access error occurs

setTypeMap

public void setTypeMap(Map map)
                throws SQLException

Installs the given type map as the type map for this connection. The type map will be used for the custom mapping of SQL structured types and distinct types.

Specified by:

setTypeMap in interface Connection

Parameters:

map - the java.util.Map object to install as the replacement for this Connection object's default type map

Throws:

SQLException - If a sql error occurs

Since:

1.2

getResourceFactoryName

public final String getResourceFactoryName()

Return the name of the factory that allocated this connection

Specified by:

getResourceFactoryName in interface ManagedResource

Returns:

The name of the factory

getDelegate

public final Connection getDelegate()

Return the wrapped connection

Returns:

The wrapped connection

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException

Gets the current auto-commit state.

Specified by:

getAutoCommit in interface Connection

Returns:

the current state of auto-commit mode

Throws:

SQLException - if a database access error occurs

See Also:

setAutoCommit(boolean)

isClosed

public boolean isClosed()
                 throws SQLException

Tests to see if a Connection is closed.

Specified by:

isClosed in interface Connection

Returns:

true if the connection is closed; false if it's still open

Throws:

SQLException - if a database access error occurs

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException

Gets the metadata regarding this connection's database. A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is made available through a DatabaseMetaData object.

Specified by:

getMetaData in interface Connection

Returns:

a DatabaseMetaData object for this Connection

Throws:

SQLException - if a database access error occurs

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Tests to see if the connection is in read-only mode.

Specified by:

isReadOnly in interface Connection

Returns:

true if connection is read-only and false otherwise

Throws:

SQLException - if a database access error occurs

getCatalog

public String getCatalog()
                  throws SQLException

Returns the Connection's current catalog name.

Specified by:

getCatalog in interface Connection

Returns:

the current catalog name or null

Throws:

SQLException - if a database access error occurs

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException

Gets this Connection's current transaction isolation level.

Specified by:

getTransactionIsolation in interface Connection

Returns:

the current TRANSACTION_* mode value

Throws:

SQLException - if a database access error occurs

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Returns the first warning reported by calls on this Connection.

Note: Subsequent warnings will be chained to this SQLWarning.

Specified by:

getWarnings in interface Connection

Returns:

the first SQLWarning or null

Throws:

SQLException - if a database access error occurs

getTypeMap

public Map getTypeMap()
               throws SQLException

Gets the type map object associated with this connection. Unless the application has added an entry to the type map, the map returned will be empty.

Specified by:

getTypeMap in interface Connection

Returns:

the java.util.Map object associated with this Connection object

Throws:

SQLException - If a sql error occurs

Since:

1.2

createStatement

public Statement createStatement()
                          throws SQLException

Creates a Statement object for sending SQL statements to the database. SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a PreparedStatement object.

Result sets created using the returned Statement object will by default have forward-only type and read-only concurrency.

Specified by:

createStatement in interface Connection

Returns:

a new Statement object

Throws:

SQLException - if a database access error occurs

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException

Creates a PreparedStatement object for sending parameterized SQL statements to the database. A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.

Result sets created using the returned PreparedStatement will have forward-only type and read-only concurrency, by default.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - a SQL statement that may contain one or more '?' IN parameter placeholders

Returns:

a new PreparedStatement object containing the pre-compiled statement

Throws:

SQLException - if a database access error occurs

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException

Creates a CallableStatement object for calling database stored procedures. The CallableStatement object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

Note: This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall is done; others may wait until the CallableStatement object is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions. Result sets created using the returned CallableStatement will have forward-only type and read-only concurrency, by default.

Specified by:

prepareCall in interface Connection

Parameters:

sql - a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.

Returns:

a new CallableStatement object containing the pre-compiled SQL statement

Throws:

SQLException - if a database access error occurs

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException

Converts the given SQL statement into the system's native SQL grammar. A driver may convert the JDBC sql grammar into its system's native SQL grammar prior to sending it; this method returns the native form of the statement that the driver would have sent.

Specified by:

nativeSQL in interface Connection

Parameters:

sql - a SQL statement that may contain one or more '?' parameter placeholders

Returns:

the native form of this statement

Throws:

SQLException - if a database access error occurs

commit

public void commit()
            throws SQLException

Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection. This method should be used only when auto-commit mode has been disabled.

Specified by:

commit in interface Connection

Throws:

SQLException - if a database access error occurs

See Also:

setAutoCommit(boolean)

rollback

public void rollback()
              throws SQLException

Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection. This method should be used only when auto- commit has been disabled.

Specified by:

rollback in interface Connection

Throws:

SQLException - if a database access error occurs

See Also:

setAutoCommit(boolean)

close

public void close()
           throws SQLException

Releases a Connection's database and JDBC resources immediately instead of waiting for them to be automatically released.

Note: A Connection is automatically closed when it is garbage collected. Certain fatal errors also result in a closed Connection.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException - if a database access error occurs

closeAnyOpenStatements

public void closeAnyOpenStatements()
                            throws SQLException

Close any open statements

Throws:

SQLException - If an error occurs

closeAnyOpenMetaDatas

public void closeAnyOpenMetaDatas()
                           throws SQLException

Close any open DatabaseMetaData objects

Throws:

SQLException - If an error occurs

clearWarnings

public void clearWarnings()
                   throws SQLException

Clears all warnings reported for this Connection object. After a call to this method, the method getWarnings returns null until a new warning is reported for this Connection.

Specified by:

clearWarnings in interface Connection

Throws:

SQLException - if a database access error occurs

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency)
                          throws SQLException

Creates a Statement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the createStatement method above, but it allows the default result set type and result set concurrency type to be overridden.

Specified by:

createStatement in interface Connection

Parameters:

resultSetType - a result set type; see ResultSet.TYPE_XXX

resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX

Returns:

a new Statement object

Throws:

SQLException - if a database access error occurs

Since:

1.2

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency)
                                   throws SQLException

Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareStatement method above, but it allows the default result set type and result set concurrency type to be overridden.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.

resultSetType - a result set type; see ResultSet.TYPE_XXX

resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX

Returns:

a new PreparedStatement object containing the pre-compiled SQL statement

Throws:

SQLException - if a database access error occurs

Since:

1.2

prepareCall

public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency)
                              throws SQLException

Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type and result set concurrency type to be overridden.

Specified by:

prepareCall in interface Connection

Parameters:

sql - a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.

resultSetType - a result set type; see ResultSet.TYPE_XXX

resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX

Returns:

a new CallableStatement object containing the pre-compiled SQL statement

Throws:

SQLException - if a database access error occurs

Since:

1.2

getOpenStatementCount

public int getOpenStatementCount()

Return the number of statements that are currently open. Useful for debugging purposes.

Returns:

The number of statements that are currently open.

setHoldability

public void setHoldability(int holdability)
                    throws SQLException

Changes the holdability of ResultSet objects created using this Connection object to the given holdability.

Specified by:

setHoldability in interface Connection

Parameters:

holdability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Throws:

SQLException - if a database access occurs, the given parameter is not a ResultSet constant indicating holdability, or the given holdability is not supported

Since:

1.4

See Also:

getHoldability(), ResultSet

getHoldability

public int getHoldability()
                   throws SQLException

Retrieves the current holdability of ResultSet objects created using this Connection object.

Specified by:

getHoldability in interface Connection

Returns:

the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Throws:

SQLException - if a database access occurs

Since:

1.4

See Also:

setHoldability(int), ResultSet

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException

Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.

Specified by:

setSavepoint in interface Connection

Returns:

the new Savepoint object

Throws:

SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode

Since:

1.4

See Also:

Savepoint

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException

Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.

Specified by:

setSavepoint in interface Connection

Parameters:

name - a String containing the name of the savepoint

Returns:

the new Savepoint object

Throws:

SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode

Since:

1.4

See Also:

Savepoint

rollback

public void rollback(Savepoint savepoint)
              throws SQLException

Undoes all changes made after the given Savepoint object was set.

This method should be used only when auto-commit has been disabled.

Specified by:

rollback in interface Connection

Parameters:

savepoint - the Savepoint object to roll back to

Throws:

SQLException - if a database access error occurs, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode

Since:

1.4

See Also:

Savepoint

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException

Removes the given Savepoint object from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.

Specified by:

releaseSavepoint in interface Connection

Parameters:

savepoint - the Savepoint object to be removed

Throws:

SQLException - if a database access error occurs or the given Savepoint object is not a valid savepoint in the current transaction

Since:

1.4

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency,
                                 int resultSetHoldability)
                          throws SQLException

Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the createStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:

createStatement in interface Connection

Parameters:

resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

Since:

1.4

See Also:

ResultSet

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws SQLException

Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.

This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - a String object that is the SQL statement to be sent to the database; may contain one or more ? IN parameters

resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

Since:

1.4

See Also:

ResultSet

prepareCall

public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency,
                                     int resultSetHoldability)
                              throws SQLException

Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Specified by:

prepareCall in interface Connection

Parameters:

sql - a String object that is the SQL statement to be sent to the database; may contain on or more ? parameters

resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

Since:

1.4

See Also:

ResultSet

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int autoGeneratedKeys)
                                   throws SQLException

Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not an INSERT statement.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

Returns:

a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys

Throws:

SQLException - if a database access error occurs or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned

Since:

1.4

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int[] columnIndexes)
                                   throws SQLException

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. This array is ignored if the SQL statement is not an INSERT statement.

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows

Returns:

a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes

Throws:

SQLException - if a database access error occurs

Since:

1.4

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          String[] columnNames)
                                   throws SQLException

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. This array is ignored if the SQL statement is not an INSERT statement.

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows

Returns:

a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names

Throws:

SQLException - if a database access error occurs

Since:

1.4

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException

Specified by:

getNetworkTimeout in interface Connection

Throws:

SQLException

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
                              int timeout)
                       throws SQLException

Specified by:

setNetworkTimeout in interface Connection

Throws:

SQLException

abort

public void abort(Executor executor)
           throws SQLException

Specified by:

abort in interface Connection

Throws:

SQLException

getSchema

public String getSchema()
                 throws SQLException

Specified by:

getSchema in interface Connection

Throws:

SQLException

setSchema

public void setSchema(String schema)
               throws SQLException

Specified by:

setSchema in interface Connection

Throws:

SQLException

createStruct

public Struct createStruct(String typeName,
                           Object[] attributes)
                    throws SQLException

Specified by:

createStruct in interface Connection

Throws:

SQLException

createArrayOf

public Array createArrayOf(String typeName,
                           Object[] elements)
                    throws SQLException

Specified by:

createArrayOf in interface Connection

Throws:

SQLException

getClientInfo

public Properties getClientInfo()
                         throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

getClientInfo

public String getClientInfo(String name)
                     throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

setClientInfo

public void setClientInfo(Properties properties)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

setClientInfo

public void setClientInfo(String name,
                          String value)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

isValid

public boolean isValid(int timeout)
                throws SQLException

Specified by:

isValid in interface Connection

Throws:

SQLException

createSQLXML

public SQLXML createSQLXML()
                    throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

createNClob

public NClob createNClob()
                  throws SQLException

Specified by:

createNClob in interface Connection

Throws:

SQLException

createBlob

public Blob createBlob()
                throws SQLException

Specified by:

createBlob in interface Connection

Throws:

SQLException

createClob

public Clob createClob()
                throws SQLException

Specified by:

createClob in interface Connection

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException