org.apache.commons.dbcp

Class PoolingConnection

java.lang.Object

org.apache.commons.dbcp.AbandonedTrace

org.apache.commons.dbcp.DelegatingConnection

org.apache.commons.dbcp.PoolingConnection

All Implemented Interfaces:

java.lang.AutoCloseable, java.sql.Connection, java.sql.Wrapper, org.apache.commons.pool.KeyedPoolableObjectFactory

public class PoolingConnection
extends DelegatingConnection
implements java.sql.Connection, org.apache.commons.pool.KeyedPoolableObjectFactory

A DelegatingConnection that pools PreparedStatements.

My prepareStatement(java.lang.String) methods, rather than creating a new PreparedStatement each time, may actually pull the PreparedStatement from a pool of unused statements. The Statement.close() method of the returned PreparedStatement doesn't actually close the statement, but rather returns it to my pool. (See PoolablePreparedStatement.)

Version:

$Revision: 1.14 $ $Date: 2004/03/07 15:26:38 $

Author:

Rodney Waldhoff, Dirk Verbeeck

See Also:

PoolablePreparedStatement

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
PoolingConnection(java.sql.Connection c) Constructor.
PoolingConnection(java.sql.Connection c, org.apache.commons.pool.KeyedObjectPool pool) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	activateObject(java.lang.Object key, java.lang.Object obj) My KeyedPoolableObjectFactory method for activating PreparedStatements.
void	close() Close and free all PreparedStatements from my pool, and close my underlying connection.
void	destroyObject(java.lang.Object key, java.lang.Object obj) My KeyedPoolableObjectFactory method for destroying PreparedStatements.
java.lang.Object	makeObject(java.lang.Object obj) My KeyedPoolableObjectFactory method for creating PreparedStatements.
void	passivateObject(java.lang.Object key, java.lang.Object obj) My KeyedPoolableObjectFactory method for passivating PreparedStatements.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql) Create or obtain a PreparedStatement from my pool.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency) Create or obtain a PreparedStatement from my pool.
java.lang.String	toString()
boolean	validateObject(java.lang.Object key, java.lang.Object obj) My KeyedPoolableObjectFactory method for validating PreparedStatements.

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

abort, clearWarnings, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, equals, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getDelegate, getHoldability, getInnermostDelegate, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, hashCode, isClosed, isReadOnly, isValid, isWrapperFor, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setDelegate, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap, unwrap

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

printStackTrace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.sql.Connection

abort, clearWarnings, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Constructor Detail

PoolingConnection

public PoolingConnection(java.sql.Connection c)

Constructor.

Parameters:

c - the underlying Connection.

PoolingConnection

public PoolingConnection(java.sql.Connection c,
                 org.apache.commons.pool.KeyedObjectPool pool)

Constructor.

Parameters:

c - the underlying Connection.

maxSleepingPerKey - the maximum number of PreparedStatements that may sit idle in my pool (per type)

Method Detail

activateObject

public void activateObject(java.lang.Object key,
                  java.lang.Object obj)
                    throws java.lang.Exception

My KeyedPoolableObjectFactory method for activating PreparedStatements. (Currently a no-op.)

Specified by:

activateObject in interface org.apache.commons.pool.KeyedPoolableObjectFactory

Parameters:

key - ignored

obj - ignored

Throws:

java.lang.Exception

close

public void close()
           throws java.sql.SQLException

Close and free all PreparedStatements from my pool, and close my underlying connection.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.sql.Connection

Overrides:

close in class DelegatingConnection

Throws:

java.sql.SQLException

destroyObject

public void destroyObject(java.lang.Object key,
                 java.lang.Object obj)
                   throws java.lang.Exception

My KeyedPoolableObjectFactory method for destroying PreparedStatements.

Specified by:

destroyObject in interface org.apache.commons.pool.KeyedPoolableObjectFactory

Parameters:

key - ignored

obj - the PreparedStatement to be destroyed.

Throws:

java.lang.Exception

makeObject

public java.lang.Object makeObject(java.lang.Object obj)
                            throws java.lang.Exception

My KeyedPoolableObjectFactory method for creating PreparedStatements.

Specified by:

makeObject in interface org.apache.commons.pool.KeyedPoolableObjectFactory

Parameters:

obj - the key for the PreparedStatement to be created

Throws:

java.lang.Exception

passivateObject

public void passivateObject(java.lang.Object key,
                   java.lang.Object obj)
                     throws java.lang.Exception

My KeyedPoolableObjectFactory method for passivating PreparedStatements. Currently invokes PreparedStatement.clearParameters().

Specified by:

passivateObject in interface org.apache.commons.pool.KeyedPoolableObjectFactory

Parameters:

key - ignored

obj - a PreparedStatement

Throws:

java.lang.Exception

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql)
                                            throws java.sql.SQLException

Create or obtain a PreparedStatement from my pool.

Specified by:

prepareStatement in interface java.sql.Connection

Overrides:

prepareStatement in class DelegatingConnection

Returns:

a PoolablePreparedStatement

Throws:

java.sql.SQLException

prepareStatement

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

Create or obtain a PreparedStatement from my pool.

Specified by:

prepareStatement in interface java.sql.Connection

Overrides:

prepareStatement in class DelegatingConnection

Returns:

a PoolablePreparedStatement

Throws:

java.sql.SQLException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateObject

public boolean validateObject(java.lang.Object key,
                     java.lang.Object obj)

My KeyedPoolableObjectFactory method for validating PreparedStatements.

Specified by:

validateObject in interface org.apache.commons.pool.KeyedPoolableObjectFactory

Parameters:

key - ignored

obj - ignored

Returns:

true