PoolingConnection (Apache Commons DBCP 2.4.0 API)

java.lang.Object
- org.apache.commons.dbcp2.AbandonedTrace
- - org.apache.commons.dbcp2.DelegatingConnection<Connection>
  - - org.apache.commons.dbcp2.PoolingConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper, KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>, TrackedUse
```
public class PoolingConnection
extends DelegatingConnection<Connection>
implements KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
```
A DelegatingConnection that pools PreparedStatements.
The prepareStatement(java.lang.String) and prepareCall(java.lang.String) methods, rather than creating a new PreparedStatement each time, may actually pull the statement from a pool of unused statements. The Statement.close() method of the returned statement doesn't actually close the statement, but rather returns it to the pool. (See PoolablePreparedStatement, PoolableCallableStatement.)

Since:

2.0

See Also:

PoolablePreparedStatement

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PoolingConnection.StatementType
Statement types.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PoolingConnection.StatementType` Statement types.

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(Connection connection)
Constructor.

Constructors
Constructor and Description
`PoolingConnection(Connection connection)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateObject(PStmtKey key, PooledObject<DelegatingPreparedStatement> pooledObject)` `KeyedPooledObjectFactory` method for activating pooled statements.
`void`	`close()` Closes and frees all `PreparedStatement`s or `CallableStatement`s from the pool, and close the underlying connection.
`protected PStmtKey`	`createKey(String sql)` Creates a PStmtKey for the given arguments.
`protected PStmtKey`	`createKey(String sql, int autoGeneratedKeys)`
`protected PStmtKey`	`createKey(String sql, int[] columnIndexes)` Creates a PStmtKey for the given arguments.
`protected PStmtKey`	`createKey(String sql, int resultSetType, int resultSetConcurrency)` Creates a PStmtKey for the given arguments.
`protected PStmtKey`	`createKey(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Creates a PStmtKey for the given arguments.
`protected PStmtKey`	`createKey(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability, PoolingConnection.StatementType stmtType)` Creates a PStmtKey for the given arguments.
`protected PStmtKey`	`createKey(String sql, int resultSetType, int resultSetConcurrency, PoolingConnection.StatementType stmtType)` Creates a PStmtKey for the given arguments.
`protected PStmtKey`	`createKey(String sql, PoolingConnection.StatementType stmtType)` Creates a PStmtKey for the given arguments.
`protected PStmtKey`	`createKey(String sql, String[] columnNames)` Creates a PStmtKey for the given arguments.
`void`	`destroyObject(PStmtKey key, PooledObject<DelegatingPreparedStatement> pooledObject)` `KeyedPooledObjectFactory` method for destroying PoolablePreparedStatements and PoolableCallableStatements.
`PooledObject<DelegatingPreparedStatement>`	`makeObject(PStmtKey key)` `KeyedPooledObjectFactory` method for creating `PoolablePreparedStatement`s or `PoolableCallableStatement`s.
`protected String`	`normalizeSQL(String sql)` Normalizes the given SQL statement, producing a canonical form that is semantically equivalent to the original.
`void`	`passivateObject(PStmtKey key, PooledObject<DelegatingPreparedStatement> pooledObject)` `KeyedPooledObjectFactory` method for passivating `PreparedStatement`s or `CallableStatement`s.
`CallableStatement`	`prepareCall(String sql)` Creates or obtains a `CallableStatement` from the pool.
`CallableStatement`	`prepareCall(String sql, int resultSetType, int resultSetConcurrency)` Creates or obtains a `CallableStatement` from the pool.
`CallableStatement`	`prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Creates or obtains a `CallableStatement` from the pool.
`PreparedStatement`	`prepareStatement(String sql)` Creates or obtains a `PreparedStatement` from the pool.
`PreparedStatement`	`prepareStatement(String sql, int autoGeneratedKeys)`
`PreparedStatement`	`prepareStatement(String sql, int[] columnIndexes)` Creates or obtains a `PreparedStatement` from the pool.
`PreparedStatement`	`prepareStatement(String sql, int resultSetType, int resultSetConcurrency)` Creates or obtains a `PreparedStatement` from the pool.
`PreparedStatement`	`prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Creates or obtains a `PreparedStatement` from the pool.
`PreparedStatement`	`prepareStatement(String sql, String[] columnNames)` Creates or obtains a `PreparedStatement` from the pool.
`void`	`setStatementPool(KeyedObjectPool<PStmtKey,DelegatingPreparedStatement> pool)` Sets the prepared statement pool.
`String`	`toString()` Returns a string representation of the metadata associated with the innermost delegate connection.
`boolean`	`validateObject(PStmtKey key, PooledObject<DelegatingPreparedStatement> pooledObject)` `KeyedPooledObjectFactory` method for validating pooled statements.

Methods inherited from class org.apache.commons.dbcp2.DelegatingConnection
abort, activate, checkOpen, clearCachedState, clearWarnings, closeInternal, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCacheState, getCatalog, getClientInfo, getClientInfo, getDefaultQueryTimeout, getDelegate, getDelegateInternal, getHoldability, getInnermostDelegate, getInnermostDelegateInternal, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, handleException, innermostDelegateEquals, isClosed, isClosedInternal, isReadOnly, isValid, isWrapperFor, nativeSQL, passivate, releaseSavepoint, rollback, rollback, setAutoCommit, setCacheState, setCatalog, setClientInfo, setClientInfo, setClosedInternal, setDefaultQueryTimeout, setDelegate, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap, unwrap

Methods inherited from class org.apache.commons.dbcp2.AbandonedTrace
addTrace, clearTrace, getLastUsed, getTrace, removeTrace, setLastUsed, setLastUsed

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PoolingConnection
```
public PoolingConnection(Connection connection)
```
    Constructor.
    
    Parameters:
    
    connection - the underlying Connection.
- Method Detail
  - activateObject
```
public void activateObject(PStmtKey key,
                           PooledObject<DelegatingPreparedStatement> pooledObject)
                    throws Exception
```
    KeyedPooledObjectFactory method for activating pooled statements.
    
    Specified by:
    
    activateObject in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
    
    Parameters:
    
    key - ignored
    
    pooledObject - wrapped pooled statement to be activated
    
    Throws:
    
    Exception
  - close
```
public void close()
           throws SQLException
```
    Closes and frees all PreparedStatements or CallableStatements from the pool, and close the underlying connection.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Connection
    
    Overrides:
    
    close in class DelegatingConnection<Connection>
    
    Throws:
    
    SQLException
  - createKey
```
protected PStmtKey createKey(String sql)
```
    Creates a PStmtKey for the given arguments.
    
    Parameters:
    
    sql - the SQL string used to define the statement
  - createKey
```
protected PStmtKey createKey(String sql,
                             int autoGeneratedKeys)
```
  - createKey
```
protected PStmtKey createKey(String sql,
                             int[] columnIndexes)
```
    Creates a PStmtKey for the given arguments.
    
    Parameters:
    
    sql - the SQL string used to define the statement
    
    columnIndexes - column indexes
  - createKey
```
protected PStmtKey createKey(String sql,
                             int resultSetType,
                             int resultSetConcurrency)
```
    Creates a PStmtKey for the given arguments.
    
    Parameters:
    
    sql - the SQL string used to define the statement
    
    resultSetType - result set type
    
    resultSetConcurrency - result set concurrency
  - createKey
```
protected PStmtKey createKey(String sql,
                             int resultSetType,
                             int resultSetConcurrency,
                             int resultSetHoldability)
```
    Creates a PStmtKey for the given arguments.
    
    Parameters:
    
    sql - the SQL string used to define the statement
    
    resultSetType - result set type
    
    resultSetConcurrency - result set concurrency
    
    resultSetHoldability - result set holdability
  - createKey
```
protected PStmtKey createKey(String sql,
                             int resultSetType,
                             int resultSetConcurrency,
                             int resultSetHoldability,
                             PoolingConnection.StatementType stmtType)
```
    Creates a PStmtKey for the given arguments.
    
    Parameters:
    
    sql - the SQL string used to define the statement
    
    resultSetType - result set type
    
    resultSetConcurrency - result set concurrency
    
    resultSetHoldability - result set holdability
    
    stmtType - statement type
  - createKey
```
protected PStmtKey createKey(String sql,
                             int resultSetType,
                             int resultSetConcurrency,
                             PoolingConnection.StatementType stmtType)
```
    Creates a PStmtKey for the given arguments.
    
    Parameters:
    
    sql - the SQL string used to define the statement
    
    resultSetType - result set type
    
    resultSetConcurrency - result set concurrency
    
    stmtType - statement type
  - createKey
```
protected PStmtKey createKey(String sql,
                             PoolingConnection.StatementType stmtType)
```
    Creates a PStmtKey for the given arguments.
    
    Parameters:
    
    sql - the SQL string used to define the statement
    
    stmtType - statement type
  - createKey
```
protected PStmtKey createKey(String sql,
                             String[] columnNames)
```
    Creates a PStmtKey for the given arguments.
    
    Parameters:
    
    sql - the SQL string used to define the statement
    
    columnNames - column names
  - destroyObject
```
public void destroyObject(PStmtKey key,
                          PooledObject<DelegatingPreparedStatement> pooledObject)
                   throws Exception
```
    KeyedPooledObjectFactory method for destroying PoolablePreparedStatements and PoolableCallableStatements. Closes the underlying statement.
    
    Specified by:
    
    destroyObject in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
    
    Parameters:
    
    key - ignored
    
    pooledObject - the wrapped pooled statement to be destroyed.
    
    Throws:
    
    Exception
  - makeObject
```
public PooledObject<DelegatingPreparedStatement> makeObject(PStmtKey key)
                                                     throws Exception
```
    KeyedPooledObjectFactory method for creating PoolablePreparedStatements or PoolableCallableStatements. The stmtType field in the key determines whether a PoolablePreparedStatement or PoolableCallableStatement is created.
    
    Specified by:
    
    makeObject in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
    
    Parameters:
    
    key - the key for the PreparedStatement to be created
    
    Throws:
    
    Exception
    
    See Also:
    
    createKey(String, int, int, StatementType)
  - normalizeSQL
```
protected String normalizeSQL(String sql)
```
    Normalizes the given SQL statement, producing a canonical form that is semantically equivalent to the original.
  - passivateObject
```
public void passivateObject(PStmtKey key,
                            PooledObject<DelegatingPreparedStatement> pooledObject)
                     throws Exception
```
    KeyedPooledObjectFactory method for passivating PreparedStatements or CallableStatements. Invokes PreparedStatement.clearParameters().
    
    Specified by:
    
    passivateObject in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
    
    Parameters:
    
    key - ignored
    
    pooledObject - a wrapped PreparedStatement
    
    Throws:
    
    Exception
  - prepareCall
```
public CallableStatement prepareCall(String sql)
                              throws SQLException
```
    Creates or obtains a CallableStatement from the pool.
    
    Specified by:
    
    prepareCall in interface Connection
    
    Overrides:
    
    prepareCall in class DelegatingConnection<Connection>
    
    Parameters:
    
    sql - the SQL string used to define the CallableStatement
    
    Returns:
    
    a PoolableCallableStatement
    
    Throws:
    
    SQLException - Wraps an underlying exception.
  - prepareCall
```
public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency)
                              throws SQLException
```
    Creates or obtains a CallableStatement from the pool.
    
    Specified by:
    
    prepareCall in interface Connection
    
    Overrides:
    
    prepareCall in class DelegatingConnection<Connection>
    
    Parameters:
    
    sql - the SQL string used to define the CallableStatement
    
    resultSetType - result set type
    
    resultSetConcurrency - result set concurrency
    
    Returns:
    
    a PoolableCallableStatement
    
    Throws:
    
    SQLException - Wraps an underlying exception.
  - prepareCall
```
public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency,
                                     int resultSetHoldability)
                              throws SQLException
```
    Creates or obtains a CallableStatement from the pool.
    
    Specified by:
    
    prepareCall in interface Connection
    
    Overrides:
    
    prepareCall in class DelegatingConnection<Connection>
    
    Parameters:
    
    sql - the SQL string used to define the CallableStatement
    
    resultSetType - result set type
    
    resultSetConcurrency - result set concurrency
    
    resultSetHoldability - result set holdability
    
    Returns:
    
    a PoolableCallableStatement
    
    Throws:
    
    SQLException - Wraps an underlying exception.
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql)
                                   throws SQLException
```
    Creates or obtains a PreparedStatement from the pool.
    
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class DelegatingConnection<Connection>
    
    Parameters:
    
    sql - the SQL string used to define the PreparedStatement
    
    Returns:
    
    a PoolablePreparedStatement
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          int autoGeneratedKeys)
                                   throws SQLException
```
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class DelegatingConnection<Connection>
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          int[] columnIndexes)
                                   throws SQLException
```
    Creates or obtains a PreparedStatement from the pool.
    
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class DelegatingConnection<Connection>
    
    Parameters:
    
    sql - the SQL string used to define the PreparedStatement
    
    columnIndexes - column indexes
    
    Returns:
    
    a PoolablePreparedStatement
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency)
                                   throws SQLException
```
    Creates or obtains a PreparedStatement from the pool.
    
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class DelegatingConnection<Connection>
    
    Parameters:
    
    sql - the SQL string used to define the PreparedStatement
    
    resultSetType - result set type
    
    resultSetConcurrency - result set concurrency
    
    Returns:
    
    a PoolablePreparedStatement
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws SQLException
```
    Creates or obtains a PreparedStatement from the pool.
    
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class DelegatingConnection<Connection>
    
    Parameters:
    
    sql - the SQL string used to define the PreparedStatement
    
    resultSetType - result set type
    
    resultSetConcurrency - result set concurrency
    
    resultSetHoldability - result set holdability
    
    Returns:
    
    a PoolablePreparedStatement
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          String[] columnNames)
                                   throws SQLException
```
    Creates or obtains a PreparedStatement from the pool.
    
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class DelegatingConnection<Connection>
    
    Parameters:
    
    sql - the SQL string used to define the PreparedStatement
    
    columnNames - column names
    
    Returns:
    
    a PoolablePreparedStatement
    
    Throws:
    
    SQLException
  - setStatementPool
```
public void setStatementPool(KeyedObjectPool<PStmtKey,DelegatingPreparedStatement> pool)
```
    Sets the prepared statement pool.
    
    Parameters:
    
    pool - the prepared statement pool.
  - toString
```
public String toString()
```
    Description copied from class: DelegatingConnection
    
    Returns a string representation of the metadata associated with the innermost delegate connection.
    
    Overrides:
    
    toString in class DelegatingConnection<Connection>
  - validateObject
```
public boolean validateObject(PStmtKey key,
                              PooledObject<DelegatingPreparedStatement> pooledObject)
```
    KeyedPooledObjectFactory method for validating pooled statements. Currently always returns true.
    
    Specified by:
    
    validateObject in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
    
    Parameters:
    
    key - ignored
    
    pooledObject - ignored
    
    Returns:
    
    true

Fields inherited from interface java.sql.Connection

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

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

Methods inherited from class java.lang.Object

PoolingConnection

activateObject

close

createKey

createKey

createKey

createKey

createKey

createKey

createKey

createKey

createKey

destroyObject

makeObject

normalizeSQL

passivateObject

prepareCall

prepareCall

prepareCall

prepareStatement

prepareStatement

prepareStatement

prepareStatement

prepareStatement

prepareStatement

setStatementPool

toString

validateObject