java.lang.AutoCloseable
, java.sql.Connection
, java.sql.Wrapper
, KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
, TrackedUse
public class PoolingConnection extends DelegatingConnection<java.sql.Connection> implements KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
DelegatingConnection
that pools PreparedStatement
s.
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
.)
PoolablePreparedStatement
Modifier and Type | Class | Description |
---|---|---|
protected static class |
PoolingConnection.StatementType |
The possible statement types.
|
Constructor | Description |
---|---|
PoolingConnection(java.sql.Connection c) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
void |
activateObject(PStmtKey key,
PooledObject<DelegatingPreparedStatement> p) |
KeyedPooledObjectFactory method for activating
pooled statements. |
void |
close() |
Close and free all
PreparedStatement s or
CallableStatement s from the pool, and close the underlying
connection. |
protected PStmtKey |
createKey(java.lang.String sql) |
Create a PStmtKey for the given arguments.
|
protected PStmtKey |
createKey(java.lang.String sql,
int autoGeneratedKeys) |
|
protected PStmtKey |
createKey(java.lang.String sql,
int[] columnIndexes) |
Create a PStmtKey for the given arguments.
|
protected PStmtKey |
createKey(java.lang.String sql,
int resultSetType,
int resultSetConcurrency) |
Create a PStmtKey for the given arguments.
|
protected PStmtKey |
createKey(java.lang.String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability) |
Create a PStmtKey for the given arguments.
|
protected PStmtKey |
createKey(java.lang.String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability,
PoolingConnection.StatementType stmtType) |
Create a PStmtKey for the given arguments.
|
protected PStmtKey |
createKey(java.lang.String sql,
int resultSetType,
int resultSetConcurrency,
PoolingConnection.StatementType stmtType) |
Create a PStmtKey for the given arguments.
|
protected PStmtKey |
createKey(java.lang.String sql,
java.lang.String[] columnNames) |
Create a PStmtKey for the given arguments.
|
protected PStmtKey |
createKey(java.lang.String sql,
PoolingConnection.StatementType stmtType) |
Create a PStmtKey for the given arguments.
|
void |
destroyObject(PStmtKey key,
PooledObject<DelegatingPreparedStatement> p) |
KeyedPooledObjectFactory method for destroying
PoolablePreparedStatements and PoolableCallableStatements. |
PooledObject<DelegatingPreparedStatement> |
makeObject(PStmtKey key) |
KeyedPooledObjectFactory method for creating
PoolablePreparedStatement s or PoolableCallableStatement s. |
protected java.lang.String |
normalizeSQL(java.lang.String sql) |
Normalize the given SQL statement, producing a
canonical form that is semantically equivalent to the original.
|
void |
passivateObject(PStmtKey key,
PooledObject<DelegatingPreparedStatement> p) |
|
java.sql.CallableStatement |
prepareCall(java.lang.String sql) |
Create or obtain a
CallableStatement from the pool. |
java.sql.CallableStatement |
prepareCall(java.lang.String sql,
int resultSetType,
int resultSetConcurrency) |
Create or obtain a
CallableStatement from the pool. |
java.sql.CallableStatement |
prepareCall(java.lang.String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability) |
Create or obtain a
CallableStatement from the pool. |
java.sql.PreparedStatement |
prepareStatement(java.lang.String sql) |
Create or obtain a
PreparedStatement from the pool. |
java.sql.PreparedStatement |
prepareStatement(java.lang.String sql,
int autoGeneratedKeys) |
|
java.sql.PreparedStatement |
prepareStatement(java.lang.String sql,
int[] columnIndexes) |
Create or obtain a
PreparedStatement from the pool. |
java.sql.PreparedStatement |
prepareStatement(java.lang.String sql,
int resultSetType,
int resultSetConcurrency) |
Create or obtain a
PreparedStatement from the pool. |
java.sql.PreparedStatement |
prepareStatement(java.lang.String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability) |
Create or obtain a
PreparedStatement from the pool. |
java.sql.PreparedStatement |
prepareStatement(java.lang.String sql,
java.lang.String[] columnNames) |
Create or obtain a
PreparedStatement from the pool. |
void |
setStatementPool(KeyedObjectPool<PStmtKey,DelegatingPreparedStatement> pool) |
|
java.lang.String |
toString() |
Returns a string representation of the metadata associated with
the innermost delegate connection.
|
boolean |
validateObject(PStmtKey key,
PooledObject<DelegatingPreparedStatement> p) |
KeyedPooledObjectFactory method for validating
pooled statements. |
addTrace, clearTrace, getLastUsed, getTrace, removeTrace, setLastUsed, setLastUsed
beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid
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
public PoolingConnection(java.sql.Connection c)
c
- the underlying Connection
.public void setStatementPool(KeyedObjectPool<PStmtKey,DelegatingPreparedStatement> pool)
public void close() throws java.sql.SQLException
PreparedStatement
s or
CallableStatement
s from the pool, and close the underlying
connection.close
in interface java.lang.AutoCloseable
close
in interface java.sql.Connection
close
in class DelegatingConnection<java.sql.Connection>
java.sql.SQLException
- Error closing connectionpublic java.sql.PreparedStatement prepareStatement(java.lang.String sql) throws java.sql.SQLException
PreparedStatement
from the pool.prepareStatement
in interface java.sql.Connection
prepareStatement
in class DelegatingConnection<java.sql.Connection>
sql
- the sql string used to define the PreparedStatementPoolablePreparedStatement
java.sql.SQLException
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLException
prepareStatement
in interface java.sql.Connection
prepareStatement
in class DelegatingConnection<java.sql.Connection>
java.sql.SQLException
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency) throws java.sql.SQLException
PreparedStatement
from the pool.prepareStatement
in interface java.sql.Connection
prepareStatement
in class DelegatingConnection<java.sql.Connection>
sql
- the sql string used to define the PreparedStatementresultSetType
- result set typeresultSetConcurrency
- result set concurrencyPoolablePreparedStatement
java.sql.SQLException
- An error occurredpublic java.sql.CallableStatement prepareCall(java.lang.String sql) throws java.sql.SQLException
CallableStatement
from the pool.prepareCall
in interface java.sql.Connection
prepareCall
in class DelegatingConnection<java.sql.Connection>
sql
- the sql string used to define the CallableStatementPoolableCallableStatement
java.sql.SQLException
- An error occurredpublic java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency) throws java.sql.SQLException
CallableStatement
from the pool.prepareCall
in interface java.sql.Connection
prepareCall
in class DelegatingConnection<java.sql.Connection>
sql
- the sql string used to define the CallableStatementresultSetType
- result set typeresultSetConcurrency
- result set concurrencyPoolableCallableStatement
java.sql.SQLException
- An error occurredpublic java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws java.sql.SQLException
PreparedStatement
from the pool.prepareStatement
in interface java.sql.Connection
prepareStatement
in class DelegatingConnection<java.sql.Connection>
sql
- the sql string used to define the PreparedStatementresultSetType
- result set typeresultSetConcurrency
- result set concurrencyresultSetHoldability
- result set holdabilityPoolablePreparedStatement
java.sql.SQLException
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLException
PreparedStatement
from the pool.prepareStatement
in interface java.sql.Connection
prepareStatement
in class DelegatingConnection<java.sql.Connection>
sql
- the sql string used to define the PreparedStatementcolumnIndexes
- column indexesPoolablePreparedStatement
java.sql.SQLException
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLException
PreparedStatement
from the pool.prepareStatement
in interface java.sql.Connection
prepareStatement
in class DelegatingConnection<java.sql.Connection>
sql
- the sql string used to define the PreparedStatementcolumnNames
- column namesPoolablePreparedStatement
java.sql.SQLException
public java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws java.sql.SQLException
CallableStatement
from the pool.prepareCall
in interface java.sql.Connection
prepareCall
in class DelegatingConnection<java.sql.Connection>
sql
- the sql string used to define the CallableStatementresultSetType
- result set typeresultSetConcurrency
- result set concurrencyresultSetHoldability
- result set holdabilityPoolableCallableStatement
java.sql.SQLException
- if a CallableStatement
cannot be obtained
from the poolprotected PStmtKey createKey(java.lang.String sql, int autoGeneratedKeys)
protected PStmtKey createKey(java.lang.String sql, int resultSetType, int resultSetConcurrency)
sql
- the sql string used to define the statementresultSetType
- result set typeresultSetConcurrency
- result set concurrencyprotected PStmtKey createKey(java.lang.String sql, int resultSetType, int resultSetConcurrency, PoolingConnection.StatementType stmtType)
sql
- the sql string used to define the statementresultSetType
- result set typeresultSetConcurrency
- result set concurrencystmtType
- statement typeprotected PStmtKey createKey(java.lang.String sql)
sql
- the sql string used to define the statementprotected PStmtKey createKey(java.lang.String sql, PoolingConnection.StatementType stmtType)
sql
- the SQL string used to define the statementstmtType
- statement typeprotected PStmtKey createKey(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
sql
- the sql string used to define the statementresultSetType
- result set typeresultSetConcurrency
- result set concurrencyresultSetHoldability
- result set holdabilityprotected PStmtKey createKey(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability, PoolingConnection.StatementType stmtType)
sql
- the sql string used to define the statementresultSetType
- result set typeresultSetConcurrency
- result set concurrencyresultSetHoldability
- result set holdabilitystmtType
- statement typeprotected PStmtKey createKey(java.lang.String sql, int[] columnIndexes)
sql
- the sql string used to define the statementcolumnIndexes
- column indexesprotected PStmtKey createKey(java.lang.String sql, java.lang.String[] columnNames)
sql
- the sql string used to define the statementcolumnNames
- column namesprotected java.lang.String normalizeSQL(java.lang.String sql)
sql
- The SQL statementpublic PooledObject<DelegatingPreparedStatement> makeObject(PStmtKey key) throws java.lang.Exception
KeyedPooledObjectFactory
method for creating
PoolablePreparedStatement
s or PoolableCallableStatement
s.
The stmtType
field in the key determines whether
a PoolablePreparedStatement or PoolableCallableStatement is created.makeObject
in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
key
- the key for the PreparedStatement
to be createdjava.lang.Exception
- An error occurredcreateKey(String, int, int, StatementType)
public void destroyObject(PStmtKey key, PooledObject<DelegatingPreparedStatement> p) throws java.lang.Exception
KeyedPooledObjectFactory
method for destroying
PoolablePreparedStatements and PoolableCallableStatements.
Closes the underlying statement.destroyObject
in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
key
- ignoredp
- the wrapped pooled statement to be destroyed.java.lang.Exception
- An error occurredKeyedPooledObjectFactory.validateObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>)
,
KeyedObjectPool.invalidateObject(K, V)
public boolean validateObject(PStmtKey key, PooledObject<DelegatingPreparedStatement> p)
KeyedPooledObjectFactory
method for validating
pooled statements. Currently always returns true.validateObject
in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
key
- ignoredp
- ignoredtrue
public void activateObject(PStmtKey key, PooledObject<DelegatingPreparedStatement> p) throws java.lang.Exception
KeyedPooledObjectFactory
method for activating
pooled statements.activateObject
in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
key
- ignoredp
- wrapped pooled statement to be activatedjava.lang.Exception
- An error occurredKeyedPooledObjectFactory.destroyObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>)
public void passivateObject(PStmtKey key, PooledObject<DelegatingPreparedStatement> p) throws java.lang.Exception
KeyedPooledObjectFactory
method for passivating
PreparedStatement
s or CallableStatement
s.
Invokes PreparedStatement.clearParameters()
.passivateObject
in interface KeyedPooledObjectFactory<PStmtKey,DelegatingPreparedStatement>
key
- ignoredp
- a wrapped PreparedStatement
java.lang.Exception
- An error occurredKeyedPooledObjectFactory.destroyObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>)
public java.lang.String toString()
DelegatingConnection
toString
in class DelegatingConnection<java.sql.Connection>
Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.