Package org.apache.commons.dbcp2
Class PoolableConnection
java.lang.Object
org.apache.commons.dbcp2.AbandonedTrace
org.apache.commons.dbcp2.DelegatingConnection<Connection>
org.apache.commons.dbcp2.PoolableConnection
- All Implemented Interfaces:
AutoCloseable
,Connection
,Wrapper
,PoolableConnectionMXBean
,org.apache.commons.pool2.TrackedUse
- Direct Known Subclasses:
PoolableManagedConnection
public class PoolableConnection
extends DelegatingConnection<Connection>
implements PoolableConnectionMXBean
A delegating connection that, rather than closing the underlying
connection, returns itself to an
ObjectPool
when
closed.- Since:
- 2.0
- Version:
- $Id: PoolableConnection.java 1658644 2015-02-10 08:59:07Z tn $
- Author:
- Rodney Waldhoff, Glenn L. Nielsen, James House
-
Field Summary
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
-
Constructor Summary
ConstructorsConstructorDescriptionPoolableConnection
(Connection conn, org.apache.commons.pool2.ObjectPool<PoolableConnection> pool, ObjectName jmxName) PoolableConnection
(Connection conn, org.apache.commons.pool2.ObjectPool<PoolableConnection> pool, ObjectName jmxName, Collection<String> disconnectSqlCodes, boolean fastFailValidation) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Returns me to my pool.Expose theDelegatingConnection.toString()
method via a bean getter so it can be read as a property via JMX.boolean
isClosed()
void
Actually close my underlyingConnection
.void
Validates the connection, using the following algorithm: IffastFailValidation
(constructor argument) istrue
and this connection has previously thrown a fatal disconnection exception, aSQLException
is thrown.Methods inherited from class org.apache.commons.dbcp2.DelegatingConnection
abort, clearCachedState, clearWarnings, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCacheState, getCatalog, getClientInfo, getClientInfo, getDefaultQueryTimeout, getDelegate, getHoldability, getInnermostDelegate, getInnermostDelegateInternal, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, innermostDelegateEquals, isReadOnly, isValid, isWrapperFor, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCacheState, setCatalog, setClientInfo, setClientInfo, setDefaultQueryTimeout, setDelegate, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap, toString, unwrap
Methods inherited from class org.apache.commons.dbcp2.AbandonedTrace
getLastUsed
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.sql.Connection
beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid
Methods inherited from interface org.apache.commons.dbcp2.PoolableConnectionMXBean
clearCachedState, clearWarnings, getAutoCommit, getCacheState, getCatalog, getHoldability, getSchema, getTransactionIsolation, isReadOnly, setAutoCommit, setCacheState, setCatalog, setHoldability, setReadOnly, setSchema, setTransactionIsolation
-
Constructor Details
-
PoolableConnection
public PoolableConnection(Connection conn, org.apache.commons.pool2.ObjectPool<PoolableConnection> pool, ObjectName jmxName, Collection<String> disconnectSqlCodes, boolean fastFailValidation) - Parameters:
conn
- my underlying connectionpool
- the pool to which I should return when closedjmxName
- JMX namedisconnectSqlCodes
- SQL_STATE codes considered fatal disconnection errorsfastFailValidation
- true means fatal disconnection errors cause subsequent validations to fail immediately (no attempt to run query or isValid)
-
PoolableConnection
public PoolableConnection(Connection conn, org.apache.commons.pool2.ObjectPool<PoolableConnection> pool, ObjectName jmxName) - Parameters:
conn
- my underlying connectionpool
- the pool to which I should return when closedjmxName
- JMX name
-
-
Method Details
-
isClosed
This method should not be used by a client to determine whether or not a connection should be return to the connection pool (by calling
close()
). Clients should always attempt to return a connection to the pool once it is no longer required.- Specified by:
isClosed
in interfaceConnection
- Specified by:
isClosed
in interfacePoolableConnectionMXBean
- Overrides:
isClosed
in classDelegatingConnection<Connection>
- Throws:
SQLException
-
close
Returns me to my pool.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceConnection
- Specified by:
close
in interfacePoolableConnectionMXBean
- Overrides:
close
in classDelegatingConnection<Connection>
- Throws:
SQLException
-
reallyClose
Actually close my underlyingConnection
.- Specified by:
reallyClose
in interfacePoolableConnectionMXBean
- Throws:
SQLException
-
getToString
Expose theDelegatingConnection.toString()
method via a bean getter so it can be read as a property via JMX.- Specified by:
getToString
in interfacePoolableConnectionMXBean
-
validate
Validates the connection, using the following algorithm:- If
fastFailValidation
(constructor argument) istrue
and this connection has previously thrown a fatal disconnection exception, aSQLException
is thrown. - If
sql
is null, the driver's #isValid(timeout)
is called. If it returnsfalse
,SQLException
is thrown; otherwise, this method returns successfully. - If
sql
is not null, it is executed as a query and if the resultingResultSet
contains at least one row, this method returns successfully. If not,SQLException
is thrown.
- Parameters:
sql
- validation querytimeout
- validation timeout- Throws:
SQLException
- if validation fails or an SQLException occurs during validation
- If
-