Class PoolableConnectionFactory
- java.lang.Object
-
- org.apache.tomcat.dbcp.dbcp2.PoolableConnectionFactory
-
- All Implemented Interfaces:
PooledObjectFactory<PoolableConnection>
- Direct Known Subclasses:
PoolableManagedConnectionFactory
public class PoolableConnectionFactory extends java.lang.Object implements PooledObjectFactory<PoolableConnection>
APooledObjectFactorythat createsPoolableConnections.- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description PoolableConnectionFactory(ConnectionFactory connFactory, javax.management.ObjectName dataSourceJmxObjectName)Creates a newPoolableConnectionFactory.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidactivateObject(PooledObject<PoolableConnection> p)Reinitializes an instance to be returned by the pool.voiddestroyObject(PooledObject<PoolableConnection> p)Destroys an instance no longer needed by the pool, using the default (NORMAL) DestroyMode.voiddestroyObject(PooledObject<PoolableConnection> p, DestroyMode mode)Destroys an instance no longer needed by the pool, using the provided DestroyMode.booleangetCacheState()Gets the cache state.ConnectionFactorygetConnectionFactory()Gets the connection factory.protected java.util.concurrent.atomic.AtomicLonggetConnectionIndex()java.util.Collection<java.lang.String>getConnectionInitSqls()javax.management.ObjectNamegetDataSourceJmxName()javax.management.ObjectNamegetDataSourceJmxObjectName()java.lang.BooleangetDefaultAutoCommit()java.lang.StringgetDefaultCatalog()java.lang.IntegergetDefaultQueryTimeout()Deprecated.java.time.DurationgetDefaultQueryTimeoutDuration()Gets the default query timeout Duration.java.lang.IntegergetDefaultQueryTimeoutSeconds()Deprecated.java.lang.BooleangetDefaultReadOnly()java.lang.StringgetDefaultSchema()intgetDefaultTransactionIsolation()java.util.Collection<java.lang.String>getDisconnectionSqlCodes()SQL_STATE codes considered to signal fatal conditions.java.time.DurationgetMaxConnDuration()Gets the Maximum connection duration.longgetMaxConnLifetimeMillis()Gets the Maximum connection lifetime in milliseconds.protected intgetMaxOpenPreparedStatements()ObjectPool<PoolableConnection>getPool()Returns theObjectPoolin whichConnections are pooled.booleangetPoolStatements()java.lang.StringgetValidationQuery()java.time.DurationgetValidationQueryTimeoutDuration()Gets the query timeout in seconds.intgetValidationQueryTimeoutSeconds()Deprecated.protected voidinitializeConnection(java.sql.Connection conn)booleanisAutoCommitOnReturn()booleanisEnableAutoCommitOnReturn()Deprecated.booleanisFastFailValidation()True means that validation will fail immediately for connections that have previously thrown SQLExceptions with SQL_STATE indicating fatal disconnection errors.booleanisRollbackOnReturn()PooledObject<PoolableConnection>makeObject()Creates an instance that can be served by the pool and wrap it in aPooledObjectto be managed by the pool.voidpassivateObject(PooledObject<PoolableConnection> p)Uninitializes an instance to be returned to the idle object pool.voidsetAutoCommitOnReturn(boolean autoCommitOnReturn)voidsetCacheState(boolean cacheState)voidsetClearStatementPoolOnReturn(boolean clearStatementPoolOnReturn)Sets whether the pool of statements (which was enabled withsetPoolStatements(boolean)) should be cleared when the connection is returned to its pool.voidsetConnectionInitSql(java.util.Collection<java.lang.String> connectionInitSqls)Sets the SQL statements I use to initialize newly createdConnections.voidsetDefaultAutoCommit(java.lang.Boolean defaultAutoCommit)Sets the default "auto commit" setting for borrowedConnectionsvoidsetDefaultCatalog(java.lang.String defaultCatalog)Sets the default "catalog" setting for borrowedConnectionsvoidsetDefaultQueryTimeout(java.lang.Integer defaultQueryTimeoutSeconds)Deprecated.voidsetDefaultQueryTimeout(java.time.Duration defaultQueryTimeoutDuration)Sets the query timeout Duration.voidsetDefaultReadOnly(java.lang.Boolean defaultReadOnly)Sets the default "read only" setting for borrowedConnectionsvoidsetDefaultSchema(java.lang.String defaultSchema)Sets the default "schema" setting for borrowedConnectionsvoidsetDefaultTransactionIsolation(int defaultTransactionIsolation)Sets the default "Transaction Isolation" setting for borrowedConnectionsvoidsetDisconnectionSqlCodes(java.util.Collection<java.lang.String> disconnectionSqlCodes)voidsetEnableAutoCommitOnReturn(boolean autoCommitOnReturn)Deprecated.voidsetFastFailValidation(boolean fastFailValidation)voidsetMaxConn(java.time.Duration maxConnDuration)Sets the maximum lifetime in milliseconds of a connection after which the connection will always fail activation, passivation and validation.voidsetMaxConnLifetimeMillis(long maxConnLifetimeMillis)Deprecated.UsesetMaxConn(Duration).voidsetMaxOpenPreparedStatements(int maxOpenPreparedStatements)Sets the maximum number of open prepared statements.voidsetMaxOpenPrepatedStatements(int maxOpenPreparedStatements)Deprecated.voidsetPool(ObjectPool<PoolableConnection> pool)Sets theObjectPoolin which to poolConnections.voidsetPoolStatements(boolean poolStatements)voidsetRollbackOnReturn(boolean rollbackOnReturn)voidsetValidationQuery(java.lang.String validationQuery)Sets the query I use tovalidateConnections.voidsetValidationQueryTimeout(int validationQueryTimeoutSeconds)Deprecated.voidsetValidationQueryTimeout(java.time.Duration validationQueryTimeoutDuration)Sets the validation query timeout, the amount of time, that connection validation will wait for a response from the database when executing a validation query.voidvalidateConnection(PoolableConnection conn)Validates the given connection if it is open.booleanvalidateObject(PooledObject<PoolableConnection> p)Ensures that the instance is safe to be returned by the pool.
-
-
-
Constructor Detail
-
PoolableConnectionFactory
public PoolableConnectionFactory(ConnectionFactory connFactory, javax.management.ObjectName dataSourceJmxObjectName)
Creates a newPoolableConnectionFactory.- Parameters:
connFactory- theConnectionFactoryfrom which to obtain baseConnectionsdataSourceJmxObjectName- The JMX object name, may be null.
-
-
Method Detail
-
activateObject
public void activateObject(PooledObject<PoolableConnection> p) throws java.lang.Exception
Description copied from interface:PooledObjectFactoryReinitializes an instance to be returned by the pool.- Specified by:
activateObjectin interfacePooledObjectFactory<PoolableConnection>- Parameters:
p- aPooledObjectwrapping the instance to be activated- Throws:
java.lang.Exception- if there is a problem activatingobj, this exception may be swallowed by the pool.- See Also:
PooledObjectFactory.destroyObject(org.apache.tomcat.dbcp.pool2.PooledObject<T>)
-
destroyObject
public void destroyObject(PooledObject<PoolableConnection> p) throws java.lang.Exception
Description copied from interface:PooledObjectFactoryDestroys an instance no longer needed by the pool, using the default (NORMAL) DestroyMode.It is important for implementations of this method to be aware that there is no guarantee about what state
objwill be in and the implementation should be prepared to handle unexpected errors.Also, an implementation must take in to consideration that instances lost to the garbage collector may never be destroyed.
- Specified by:
destroyObjectin interfacePooledObjectFactory<PoolableConnection>- Parameters:
p- aPooledObjectwrapping the instance to be destroyed- Throws:
java.lang.Exception- should be avoided as it may be swallowed by the pool implementation.- See Also:
PooledObjectFactory.validateObject(org.apache.tomcat.dbcp.pool2.PooledObject<T>),ObjectPool.invalidateObject(T)
-
destroyObject
public void destroyObject(PooledObject<PoolableConnection> p, DestroyMode mode) throws java.lang.Exception
Description copied from interface:PooledObjectFactoryDestroys an instance no longer needed by the pool, using the provided DestroyMode.- Specified by:
destroyObjectin interfacePooledObjectFactory<PoolableConnection>- Parameters:
p- aPooledObjectwrapping the instance to be destroyedmode- DestroyMode providing context to the factory- Throws:
java.lang.Exception- should be avoided as it may be swallowed by the pool implementation.- Since:
- 2.9.0
- See Also:
PooledObjectFactory.validateObject(org.apache.tomcat.dbcp.pool2.PooledObject<T>),ObjectPool.invalidateObject(T),PooledObjectFactory.destroyObject(PooledObject),DestroyMode
-
getCacheState
public boolean getCacheState()
Gets the cache state.- Returns:
- The cache state.
- Since:
- Made public in 2.6.0.
-
getConnectionFactory
public ConnectionFactory getConnectionFactory()
Gets the connection factory.- Returns:
- The connection factory.
- Since:
- Made public in 2.6.0.
-
getConnectionIndex
protected java.util.concurrent.atomic.AtomicLong getConnectionIndex()
-
getConnectionInitSqls
public java.util.Collection<java.lang.String> getConnectionInitSqls()
- Returns:
- The collection of initialization SQL statements.
- Since:
- 2.6.0
-
getDataSourceJmxName
public javax.management.ObjectName getDataSourceJmxName()
- Returns:
- The data source JMX ObjectName
- Since:
- Made public in 2.6.0.
-
getDataSourceJmxObjectName
public javax.management.ObjectName getDataSourceJmxObjectName()
- Returns:
- The data source JMS ObjectName.
- Since:
- 2.6.0
-
getDefaultAutoCommit
public java.lang.Boolean getDefaultAutoCommit()
- Returns:
- Default auto-commit value.
- Since:
- 2.6.0
-
getDefaultCatalog
public java.lang.String getDefaultCatalog()
- Returns:
- Default catalog.
- Since:
- 2.6.0
-
getDefaultQueryTimeout
@Deprecated public java.lang.Integer getDefaultQueryTimeout()
Deprecated.- Returns:
- Default query timeout in seconds.
-
getDefaultQueryTimeoutDuration
public java.time.Duration getDefaultQueryTimeoutDuration()
Gets the default query timeout Duration.- Returns:
- Default query timeout Duration.
- Since:
- 2.10.0
-
getDefaultQueryTimeoutSeconds
@Deprecated public java.lang.Integer getDefaultQueryTimeoutSeconds()
Deprecated.- Returns:
- Default query timeout in seconds.
- Since:
- 2.6.0
-
getDefaultReadOnly
public java.lang.Boolean getDefaultReadOnly()
- Returns:
- Default read-only-value.
- Since:
- 2.6.0
-
getDefaultSchema
public java.lang.String getDefaultSchema()
- Returns:
- Default schema.
- Since:
- 2.6.0
-
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation()
- Returns:
- Default transaction isolation.
- Since:
- 2.6.0
-
getDisconnectionSqlCodes
public java.util.Collection<java.lang.String> getDisconnectionSqlCodes()
SQL_STATE codes considered to signal fatal conditions.Overrides the defaults in
Utils.DISCONNECTION_SQL_CODES(plus anything starting withUtils.DISCONNECTION_SQL_CODE_PREFIX). If this property is non-null andisFastFailValidation()istrue, 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()isfalsesetting this property has no effect.- Returns:
- SQL_STATE codes overriding defaults
- Since:
- 2.1
-
getMaxConnDuration
public java.time.Duration getMaxConnDuration()
Gets the Maximum connection duration.- Returns:
- Maximum connection duration.
- Since:
- 2.10.0
-
getMaxConnLifetimeMillis
public long getMaxConnLifetimeMillis()
Gets the Maximum connection lifetime in milliseconds.- Returns:
- Maximum connection lifetime in milliseconds.
- Since:
- 2.6.0
-
getMaxOpenPreparedStatements
protected int getMaxOpenPreparedStatements()
-
getPool
public ObjectPool<PoolableConnection> getPool()
Returns theObjectPoolin whichConnections are pooled.- Returns:
- the connection pool
-
getPoolStatements
public boolean getPoolStatements()
- Returns:
- Whether to pool statements.
- Since:
- Made public in 2.6.0.
-
getValidationQuery
public java.lang.String getValidationQuery()
- Returns:
- Validation query.
- Since:
- 2.6.0
-
getValidationQueryTimeoutDuration
public java.time.Duration getValidationQueryTimeoutDuration()
Gets the query timeout in seconds.- Returns:
- Validation query timeout in seconds.
- Since:
- 2.10.0
-
getValidationQueryTimeoutSeconds
@Deprecated public int getValidationQueryTimeoutSeconds()
Deprecated.Gets the query timeout in seconds.- Returns:
- Validation query timeout in seconds.
- Since:
- 2.6.0
-
initializeConnection
protected void initializeConnection(java.sql.Connection conn) throws java.sql.SQLException- Throws:
java.sql.SQLException
-
isAutoCommitOnReturn
public boolean isAutoCommitOnReturn()
- Returns:
- Whether to auto-commit on return.
- Since:
- 2.6.0
-
isEnableAutoCommitOnReturn
@Deprecated public boolean isEnableAutoCommitOnReturn()
Deprecated.- Returns:
- Whether to auto-commit on return.
-
isFastFailValidation
public boolean isFastFailValidation()
True means that validation will fail immediately for connections that have previously thrown SQLExceptions with SQL_STATE indicating fatal disconnection errors.- Returns:
- true if connections created by this factory will fast fail validation.
- Since:
- 2.1, 2.5.0 Defaults to true, previous versions defaulted to false.
- See Also:
setDisconnectionSqlCodes(Collection)
-
isRollbackOnReturn
public boolean isRollbackOnReturn()
- Returns:
- Whether to rollback on return.
-
makeObject
public PooledObject<PoolableConnection> makeObject() throws java.lang.Exception
Description copied from interface:PooledObjectFactoryCreates an instance that can be served by the pool and wrap it in aPooledObjectto be managed by the pool.- Specified by:
makeObjectin interfacePooledObjectFactory<PoolableConnection>- Returns:
- a
PooledObjectwrapping an instance that can be served by the pool - Throws:
java.lang.Exception- if there is a problem creating a new instance, this will be propagated to the code requesting an object.
-
passivateObject
public void passivateObject(PooledObject<PoolableConnection> p) throws java.lang.Exception
Description copied from interface:PooledObjectFactoryUninitializes an instance to be returned to the idle object pool.- Specified by:
passivateObjectin interfacePooledObjectFactory<PoolableConnection>- Parameters:
p- aPooledObjectwrapping the instance to be passivated- Throws:
java.lang.Exception- if there is a problem passivatingobj, this exception may be swallowed by the pool.- See Also:
PooledObjectFactory.destroyObject(org.apache.tomcat.dbcp.pool2.PooledObject<T>)
-
setAutoCommitOnReturn
public void setAutoCommitOnReturn(boolean autoCommitOnReturn)
-
setCacheState
public void setCacheState(boolean cacheState)
-
setClearStatementPoolOnReturn
public void setClearStatementPoolOnReturn(boolean clearStatementPoolOnReturn)
Sets whether the pool of statements (which was enabled withsetPoolStatements(boolean)) should be cleared when the connection is returned to its pool. Default is false.- Parameters:
clearStatementPoolOnReturn- clear or not- Since:
- 2.8.0
-
setConnectionInitSql
public void setConnectionInitSql(java.util.Collection<java.lang.String> connectionInitSqls)
Sets the SQL statements I use to initialize newly createdConnections. Usingnullturns off connection initialization.- Parameters:
connectionInitSqls- SQL statement to initializeConnections.
-
setDefaultAutoCommit
public void setDefaultAutoCommit(java.lang.Boolean defaultAutoCommit)
Sets the default "auto commit" setting for borrowedConnections- Parameters:
defaultAutoCommit- the default "auto commit" setting for borrowedConnections
-
setDefaultCatalog
public void setDefaultCatalog(java.lang.String defaultCatalog)
Sets the default "catalog" setting for borrowedConnections- Parameters:
defaultCatalog- the default "catalog" setting for borrowedConnections
-
setDefaultQueryTimeout
public void setDefaultQueryTimeout(java.time.Duration defaultQueryTimeoutDuration)
Sets the query timeout Duration.- Parameters:
defaultQueryTimeoutDuration- the query timeout Duration.- Since:
- 2.10.0
-
setDefaultQueryTimeout
@Deprecated public void setDefaultQueryTimeout(java.lang.Integer defaultQueryTimeoutSeconds)
Deprecated.Sets the query timeout in seconds.- Parameters:
defaultQueryTimeoutSeconds- the query timeout in seconds.
-
setDefaultReadOnly
public void setDefaultReadOnly(java.lang.Boolean defaultReadOnly)
Sets the default "read only" setting for borrowedConnections- Parameters:
defaultReadOnly- the default "read only" setting for borrowedConnections
-
setDefaultSchema
public void setDefaultSchema(java.lang.String defaultSchema)
Sets the default "schema" setting for borrowedConnections- Parameters:
defaultSchema- the default "schema" setting for borrowedConnections- Since:
- 2.5.0
-
setDefaultTransactionIsolation
public void setDefaultTransactionIsolation(int defaultTransactionIsolation)
Sets the default "Transaction Isolation" setting for borrowedConnections- Parameters:
defaultTransactionIsolation- the default "Transaction Isolation" setting for returnedConnections
-
setDisconnectionSqlCodes
public void setDisconnectionSqlCodes(java.util.Collection<java.lang.String> disconnectionSqlCodes)
- Parameters:
disconnectionSqlCodes- The disconnection SQL codes.- Since:
- 2.1
- See Also:
getDisconnectionSqlCodes()
-
setEnableAutoCommitOnReturn
@Deprecated public void setEnableAutoCommitOnReturn(boolean autoCommitOnReturn)
Deprecated.- Parameters:
autoCommitOnReturn- Whether to auto-commit on return.
-
setFastFailValidation
public void setFastFailValidation(boolean fastFailValidation)
- Parameters:
fastFailValidation- true means connections created by this factory will fast fail validation- Since:
- 2.1
- See Also:
isFastFailValidation()
-
setMaxConn
public void setMaxConn(java.time.Duration maxConnDuration)
Sets the maximum lifetime in milliseconds of a connection after which the connection will always fail activation, passivation and validation. A value of zero or less indicates an infinite lifetime. The default value is -1.- Parameters:
maxConnDuration- The maximum lifetime in milliseconds.- Since:
- 2.10.0
-
setMaxConnLifetimeMillis
@Deprecated public void setMaxConnLifetimeMillis(long maxConnLifetimeMillis)
Deprecated.UsesetMaxConn(Duration).Sets the maximum lifetime in milliseconds of a connection after which the connection will always fail activation, passivation and validation. A value of zero or less indicates an infinite lifetime. The default value is -1.- Parameters:
maxConnLifetimeMillis- The maximum lifetime in milliseconds.
-
setMaxOpenPreparedStatements
public void setMaxOpenPreparedStatements(int maxOpenPreparedStatements)
Sets the maximum number of open prepared statements.- Parameters:
maxOpenPreparedStatements- The maximum number of open prepared statements.
-
setMaxOpenPrepatedStatements
@Deprecated public void setMaxOpenPrepatedStatements(int maxOpenPreparedStatements)
Deprecated.Deprecated due to typo in method name.- Parameters:
maxOpenPreparedStatements- The maximum number of open prepared statements.
-
setPool
public void setPool(ObjectPool<PoolableConnection> pool)
Sets theObjectPoolin which to poolConnections.- Parameters:
pool- theObjectPoolin which to pool thoseConnections
-
setPoolStatements
public void setPoolStatements(boolean poolStatements)
-
setRollbackOnReturn
public void setRollbackOnReturn(boolean rollbackOnReturn)
-
setValidationQuery
public void setValidationQuery(java.lang.String validationQuery)
Sets the query I use tovalidateConnections. Should return at least one row. If not specified,Connection.isValid(int)will be used to validate connections.- Parameters:
validationQuery- a query to use tovalidateConnections.
-
setValidationQueryTimeout
public void setValidationQueryTimeout(java.time.Duration validationQueryTimeoutDuration)
Sets the validation query timeout, the amount of time, that connection validation will wait for a response from the database when executing a validation query. Use a value less than or equal to 0 for no timeout.- Parameters:
validationQueryTimeoutDuration- new validation query timeout duration.- Since:
- 2.10.0
-
setValidationQueryTimeout
@Deprecated public void setValidationQueryTimeout(int validationQueryTimeoutSeconds)
Deprecated.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. Use a value less than or equal to 0 for no timeout.- Parameters:
validationQueryTimeoutSeconds- new validation query timeout value in seconds
-
validateConnection
public void validateConnection(PoolableConnection conn) throws java.sql.SQLException
Validates the given connection if it is open.- Parameters:
conn- the connection to validate.- Throws:
java.sql.SQLException- if the connection is closed or validate fails.
-
validateObject
public boolean validateObject(PooledObject<PoolableConnection> p)
Description copied from interface:PooledObjectFactoryEnsures that the instance is safe to be returned by the pool.- Specified by:
validateObjectin interfacePooledObjectFactory<PoolableConnection>- Parameters:
p- aPooledObjectwrapping the instance to be validated- Returns:
falseifobjis not valid and should be dropped from the pool,trueotherwise.
-
-