Package org.apache.commons.dbcp

Class DelegatingConnection

java.lang.Object

org.apache.commons.dbcp.AbandonedTrace

org.apache.commons.dbcp.DelegatingConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper

Direct Known Subclasses:

ManagedConnection, PoolableConnection, PoolingConnection

public class DelegatingConnection
extends AbandonedTrace
implements Connection

A base delegating implementation of Connection.

All of the methods from the Connection interface simply check to see that the Connection is active, and call the corresponding method on the "delegate" provided in my constructor.

Extends AbandonedTrace to implement Connection tracking and logging of code which created the Connection. Tracking the Connection ensures that the AbandonedObjectPool can close this connection and recycle it if its pool of connections is nearing exhaustion and this connection's last usage is older than the removeAbandonedTimeout.

Version:

$Revision: 896719 $ $Date: 2010-01-06 18:42:22 -0500 (Wed, 06 Jan 2010) $

Author:

Rodney Waldhoff, Glenn L. Nielsen, James House, Dirk Verbeeck

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_closed
protected Connection	_conn	My delegate Connection.

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor	Description
DelegatingConnection(Connection c)	Create a wrapper for the Connection which traces this Connection in the AbandonedObjectPool.
DelegatingConnection(Connection c, AbandonedConfig config)	Create a wrapper for the Connection which traces the Statements created so that any unclosed Statements can be closed when this Connection is closed.

Method Summary

Modifier and Type	Method	Description
void	abort(Executor executor)
protected void	activate()
protected void	checkOpen()
void	clearWarnings()
void	close()	Closes the underlying connection, and close any Statements that were not explicitly closed.
void	commit()
Array	createArrayOf(String typeName, Object[] elements)
Blob	createBlob()
Clob	createClob()
NClob	createNClob()
SQLXML	createSQLXML()
Statement	createStatement()
Statement	createStatement(int resultSetType, int resultSetConcurrency)
Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
Struct	createStruct(String typeName, Object[] attributes)
boolean	equals(Object obj)	This method considers two objects to be equal if the underlying jdbc objects are equal.
boolean	getAutoCommit()
String	getCatalog()
Properties	getClientInfo()
String	getClientInfo(String name)
Connection	getDelegate()	Returns my underlying Connection.
protected Connection	getDelegateInternal()	Should be final but can't be for compatibility with previous releases.
int	getHoldability()
Connection	getInnermostDelegate()	If my underlying Connection is not a DelegatingConnection, returns it, otherwise recursively invokes this method on my delegate.
protected Connection	getInnermostDelegateInternal()
DatabaseMetaData	getMetaData()
int	getNetworkTimeout()
String	getSchema()
int	getTransactionIsolation()
Map	getTypeMap()
SQLWarning	getWarnings()
protected void	handleException(SQLException e)
int	hashCode()
boolean	innermostDelegateEquals(Connection c)	Compares innermost delegate to the given connection.
boolean	isClosed()
boolean	isReadOnly()
boolean	isValid(int timeout)
boolean	isWrapperFor(Class<?> iface)
String	nativeSQL(String sql)
protected void	passivate()
CallableStatement	prepareCall(String sql)
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency)
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String sql)
PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
PreparedStatement	prepareStatement(String sql, int[] columnIndexes)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String sql, String[] columnNames)
void	releaseSavepoint(Savepoint savepoint)
void	rollback()
void	rollback(Savepoint savepoint)
void	setAutoCommit(boolean autoCommit)
void	setCatalog(String catalog)
void	setClientInfo(String name, String value)
void	setClientInfo(Properties properties)
void	setDelegate(Connection c)	Sets my delegate.
void	setHoldability(int holdability)
void	setNetworkTimeout(Executor executor, int milliseconds)
void	setReadOnly(boolean readOnly)
Savepoint	setSavepoint()
Savepoint	setSavepoint(String name)
void	setSchema(String schema)
void	setTransactionIsolation(int level)
void	setTypeMap(Map map)
String	toString()	Returns a string representation of the metadata associated with the innnermost delegate connection.
<T> T	unwrap(Class<T> iface)

Methods inherited from class org.apache.commons.dbcp.AbandonedTrace

addTrace, clearTrace, getConfig, getLastUsed, getTrace, printStackTrace, removeTrace, setLastUsed, setLastUsed, setStackTrace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.sql.Connection

beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Field Detail

_conn

protected Connection _conn

My delegate Connection.

_closed

protected boolean _closed

Constructor Detail

DelegatingConnection

public DelegatingConnection(Connection c)

Create a wrapper for the Connection which traces this Connection in the AbandonedObjectPool.

Parameters:

c - the Connection to delegate all calls to.

DelegatingConnection

public DelegatingConnection(Connection c,
                            AbandonedConfig config)

Create a wrapper for the Connection which traces the Statements created so that any unclosed Statements can be closed when this Connection is closed.

Parameters:

c - the Connection to delegate all calls to.

config - the configuration for tracing abandoned objects

Method Detail

toString

public String toString()

Returns a string representation of the metadata associated with the innnermost delegate connection.

Overrides:

toString in class Object

Since:

1.2.2

getDelegate

public Connection getDelegate()

Returns my underlying Connection.

Returns:

my underlying Connection.

getDelegateInternal

protected Connection getDelegateInternal()

Should be final but can't be for compatibility with previous releases.

innermostDelegateEquals

public boolean innermostDelegateEquals(Connection c)

Compares innermost delegate to the given connection.

Parameters:

c - connection to compare innermost delegate with

Returns:

true if innermost delegate equals c

Since:

1.2.2

equals

public boolean equals(Object obj)

This method considers two objects to be equal if the underlying jdbc objects are equal.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getInnermostDelegate

public Connection getInnermostDelegate()

If my underlying Connection is not a DelegatingConnection, returns it, otherwise recursively invokes this method on my delegate.

Hence this method will return the first delegate that is not a DelegatingConnection, or null when no non-DelegatingConnection delegate can be found by traversing this chain.

This method is useful when you may have nested DelegatingConnections, and you want to make sure to obtain a "genuine" Connection.

getInnermostDelegateInternal

protected final Connection getInnermostDelegateInternal()

setDelegate

public void setDelegate(Connection c)

Sets my delegate.

close

public void close()
           throws SQLException

Closes the underlying connection, and close any Statements that were not explicitly closed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

handleException

protected void handleException(SQLException e)
                        throws SQLException

Throws:

SQLException

createStatement

public Statement createStatement()
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

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

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareCall

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

Specified by:

prepareCall in interface Connection

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Connection

Throws:

SQLException

commit

public void commit()
            throws SQLException

Specified by:

commit in interface Connection

Throws:

SQLException

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException

Specified by:

getAutoCommit in interface Connection

Throws:

SQLException

getCatalog

public String getCatalog()
                  throws SQLException

Specified by:

getCatalog in interface Connection

Throws:

SQLException

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException

Specified by:

getMetaData in interface Connection

Throws:

SQLException

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException

Specified by:

getTransactionIsolation in interface Connection

Throws:

SQLException

getTypeMap

public Map getTypeMap()
               throws SQLException

Specified by:

getTypeMap in interface Connection

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Connection

Throws:

SQLException

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

rollback

public void rollback()
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException

Specified by:

setAutoCommit in interface Connection

Throws:

SQLException

setCatalog

public void setCatalog(String catalog)
                throws SQLException

Specified by:

setCatalog in interface Connection

Throws:

SQLException

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

Specified by:

setReadOnly in interface Connection

Throws:

SQLException

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Specified by:

setTransactionIsolation in interface Connection

Throws:

SQLException

setTypeMap

public void setTypeMap(Map map)
                throws SQLException

Specified by:

setTypeMap in interface Connection

Throws:

SQLException

isClosed

public boolean isClosed()
                 throws SQLException

Specified by:

isClosed in interface Connection

Throws:

SQLException

checkOpen

protected void checkOpen()
                  throws SQLException

Throws:

SQLException

activate

protected void activate()

passivate

protected void passivate()
                  throws SQLException

Throws:

SQLException

getHoldability

public int getHoldability()
                   throws SQLException

Specified by:

getHoldability in interface Connection

Throws:

SQLException

setHoldability

public void setHoldability(int holdability)
                    throws SQLException

Specified by:

setHoldability in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

rollback

public void rollback(Savepoint savepoint)
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException

Specified by:

releaseSavepoint in interface Connection

Throws:

SQLException

createStatement

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

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

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

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement 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

createArrayOf

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

Specified by:

createArrayOf 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

createNClob

public NClob createNClob()
                  throws SQLException

Specified by:

createNClob in interface Connection

Throws:

SQLException

createSQLXML

public SQLXML createSQLXML()
                    throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

createStruct

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

Specified by:

createStruct in interface Connection

Throws:

SQLException

isValid

public boolean isValid(int timeout)
                throws SQLException

Specified by:

isValid in interface Connection

Throws:

SQLException

setClientInfo

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

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

setClientInfo

public void setClientInfo(Properties properties)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

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

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException

Specified by:

getNetworkTimeout in interface Connection

Throws:

SQLException

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
                              int milliseconds)
                       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