public class PoolableConnectionFactory extends java.lang.Object implements org.apache.commons.pool2.PooledObjectFactory<PoolableConnection>
PooledObjectFactory
that creates
PoolableConnection
s.Constructor and Description |
---|
PoolableConnectionFactory(ConnectionFactory connFactory,
javax.management.ObjectName dataSourceJmxName)
Create a new
PoolableConnectionFactory . |
Modifier and Type | Method and Description |
---|---|
void |
activateObject(org.apache.commons.pool2.PooledObject<PoolableConnection> p) |
void |
destroyObject(org.apache.commons.pool2.PooledObject<PoolableConnection> p) |
java.lang.Integer |
getDefaultQueryTimeout() |
java.util.Collection<java.lang.String> |
getDisconnectionSqlCodes()
SQL_STATE codes considered to signal fatal conditions.
|
org.apache.commons.pool2.ObjectPool<PoolableConnection> |
getPool()
Returns the
ObjectPool in which Connection s are pooled. |
boolean |
isEnableAutoCommitOnReturn() |
boolean |
isFastFailValidation()
True means that validation will fail immediately for connections that
have previously thrown SQLExceptions with SQL_STATE indicating fatal
disconnection errors.
|
boolean |
isRollbackOnReturn() |
org.apache.commons.pool2.PooledObject<PoolableConnection> |
makeObject() |
void |
passivateObject(org.apache.commons.pool2.PooledObject<PoolableConnection> p) |
void |
setCacheState(boolean cacheState) |
void |
setConnectionInitSql(java.util.Collection<java.lang.String> connectionInitSqls)
Sets the SQL statements I use to initialize newly created
Connection s. |
void |
setDefaultAutoCommit(java.lang.Boolean defaultAutoCommit)
Sets the default "auto commit" setting for borrowed
Connection s |
void |
setDefaultCatalog(java.lang.String defaultCatalog)
Sets the default "catalog" setting for borrowed
Connection s |
void |
setDefaultQueryTimeout(java.lang.Integer defaultQueryTimeout) |
void |
setDefaultReadOnly(java.lang.Boolean defaultReadOnly)
Sets the default "read only" setting for borrowed
Connection s |
void |
setDefaultTransactionIsolation(int defaultTransactionIsolation)
Sets the default "Transaction Isolation" setting for borrowed
Connection s |
void |
setDisconnectionSqlCodes(java.util.Collection<java.lang.String> disconnectionSqlCodes) |
void |
setEnableAutoCommitOnReturn(boolean enableAutoCommitOnReturn) |
void |
setFastFailValidation(boolean fastFailValidation) |
void |
setMaxConnLifetimeMillis(long maxConnLifetimeMillis)
Sets the maximum lifetime in milliseconds of a connection after which the
connection will always fail activation, passivation and validation.
|
void |
setMaxOpenPrepatedStatements(int maxOpenPreparedStatements) |
void |
setPool(org.apache.commons.pool2.ObjectPool<PoolableConnection> pool)
Sets the
ObjectPool in which to pool Connection s. |
void |
setPoolStatements(boolean poolStatements) |
void |
setRollbackOnReturn(boolean rollbackOnReturn) |
void |
setValidationQuery(java.lang.String validationQuery)
Sets the query I use to
validate Connection s. |
void |
setValidationQueryTimeout(int timeout)
Sets the validation query timeout, the amount of time, in seconds, that
connection validation will wait for a response from the database when
executing a validation query.
|
void |
validateConnection(PoolableConnection conn) |
boolean |
validateObject(org.apache.commons.pool2.PooledObject<PoolableConnection> p) |
public PoolableConnectionFactory(ConnectionFactory connFactory, javax.management.ObjectName dataSourceJmxName)
PoolableConnectionFactory
.connFactory
- the ConnectionFactory
from which to obtain
base Connection
spublic void activateObject(org.apache.commons.pool2.PooledObject<PoolableConnection> p) throws java.lang.Exception
activateObject
in interface org.apache.commons.pool2.PooledObjectFactory<PoolableConnection>
java.lang.Exception
public void destroyObject(org.apache.commons.pool2.PooledObject<PoolableConnection> p) throws java.lang.Exception
destroyObject
in interface org.apache.commons.pool2.PooledObjectFactory<PoolableConnection>
java.lang.Exception
public java.lang.Integer getDefaultQueryTimeout()
public java.util.Collection<java.lang.String> getDisconnectionSqlCodes()
Overrides the defaults in Utils.DISCONNECTION_SQL_CODES
(plus anything starting with Utils.DISCONNECTION_SQL_CODE_PREFIX
).
If this property is non-null and isFastFailValidation()
is
true
, whenever connections created by this factory generate exceptions
with SQL_STATE codes in this list, they will be marked as "fatally disconnected"
and subsequent validations will fail fast (no attempt at isValid or validation
query).
If isFastFailValidation()
is false
setting this property has no
effect.
public org.apache.commons.pool2.ObjectPool<PoolableConnection> getPool()
ObjectPool
in which Connection
s are pooled.public boolean isEnableAutoCommitOnReturn()
public boolean isFastFailValidation()
setDisconnectionSqlCodes(Collection)
public boolean isRollbackOnReturn()
public org.apache.commons.pool2.PooledObject<PoolableConnection> makeObject() throws java.lang.Exception
makeObject
in interface org.apache.commons.pool2.PooledObjectFactory<PoolableConnection>
java.lang.Exception
public void passivateObject(org.apache.commons.pool2.PooledObject<PoolableConnection> p) throws java.lang.Exception
passivateObject
in interface org.apache.commons.pool2.PooledObjectFactory<PoolableConnection>
java.lang.Exception
public void setCacheState(boolean cacheState)
public void setConnectionInitSql(java.util.Collection<java.lang.String> connectionInitSqls)
Connection
s.
Using null
turns off connection initialization.connectionInitSqls
- SQL statement to initialize Connection
s.public void setDefaultAutoCommit(java.lang.Boolean defaultAutoCommit)
Connection
sdefaultAutoCommit
- the default "auto commit" setting for borrowed Connection
spublic void setDefaultCatalog(java.lang.String defaultCatalog)
Connection
sdefaultCatalog
- the default "catalog" setting for borrowed Connection
spublic void setDefaultQueryTimeout(java.lang.Integer defaultQueryTimeout)
public void setDefaultReadOnly(java.lang.Boolean defaultReadOnly)
Connection
sdefaultReadOnly
- the default "read only" setting for borrowed Connection
spublic void setDefaultTransactionIsolation(int defaultTransactionIsolation)
Connection
sdefaultTransactionIsolation
- the default "Transaction Isolation" setting for returned Connection
spublic void setDisconnectionSqlCodes(java.util.Collection<java.lang.String> disconnectionSqlCodes)
disconnectionSqlCodes
- getDisconnectionSqlCodes()
public void setEnableAutoCommitOnReturn(boolean enableAutoCommitOnReturn)
public void setFastFailValidation(boolean fastFailValidation)
fastFailValidation
- true means connections created by this factory will
fast fail validationisFastFailValidation()
public void setMaxConnLifetimeMillis(long maxConnLifetimeMillis)
public void setMaxOpenPrepatedStatements(int maxOpenPreparedStatements)
public void setPool(org.apache.commons.pool2.ObjectPool<PoolableConnection> pool)
ObjectPool
in which to pool Connection
s.pool
- the ObjectPool
in which to pool those Connection
spublic void setPoolStatements(boolean poolStatements)
public void setRollbackOnReturn(boolean rollbackOnReturn)
public void setValidationQuery(java.lang.String validationQuery)
validate
Connection
s.
Should return at least one row. If not specified,
Connection.isValid(int)
will be used to validate connections.validationQuery
- a query to use to validate
Connection
s.public void setValidationQueryTimeout(int timeout)
timeout
- new validation query timeout value in secondspublic void validateConnection(PoolableConnection conn) throws java.sql.SQLException
java.sql.SQLException
public boolean validateObject(org.apache.commons.pool2.PooledObject<PoolableConnection> p)
validateObject
in interface org.apache.commons.pool2.PooledObjectFactory<PoolableConnection>
Copyright © 2001-2015 Apache Software Foundation. Documenation generated July 8 2017.