Class PoolableConnectionFactory
- All Implemented Interfaces:
- PooledObjectFactory<PoolableConnection>
- Direct Known Subclasses:
- PoolableManagedConnectionFactory
PooledObjectFactory that creates PoolableConnections.- Since:
- 2.0
- 
Constructor SummaryConstructorsConstructorDescriptionPoolableConnectionFactory(ConnectionFactory connFactory, ObjectName dataSourceJmxObjectName) Creates a newPoolableConnectionFactory.
- 
Method SummaryModifier and TypeMethodDescriptionvoidReinitializes an instance to be returned by the pool.voidDestroys an instance no longer needed by the pool, using the default (NORMAL) DestroyMode.voidDestroys an instance no longer needed by the pool, using the provided DestroyMode.booleanGets the cache state.Gets the connection factory.protected AtomicLongDeprecated.Gets the default query timeout Duration.Deprecated.intSQL_STATE codes considered to signal fatal conditions.Gets the Maximum connection duration.longGets the Maximum connection lifetime in milliseconds.protected intgetPool()Returns theObjectPoolin whichConnections are pooled.booleanGets the query timeout in seconds.intDeprecated.protected voidbooleanbooleanDeprecated.booleanTrue means that validation will fail immediately for connections that have previously thrown SQLExceptions with SQL_STATE indicating fatal disconnection errors.booleanCreates an instance that can be served by the pool and wrap it in aPooledObjectto be managed by the pool.voidUninitializes 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(Collection<String> connectionInitSqls) Sets the SQL statements I use to initialize newly createdConnections.voidsetDefaultAutoCommit(Boolean defaultAutoCommit) Sets the default "auto commit" setting for borrowedConnectionsvoidsetDefaultCatalog(String defaultCatalog) Sets the default "catalog" setting for borrowedConnectionsvoidsetDefaultQueryTimeout(Integer defaultQueryTimeoutSeconds) Deprecated.voidsetDefaultQueryTimeout(Duration defaultQueryTimeoutDuration) Sets the query timeout Duration.voidsetDefaultReadOnly(Boolean defaultReadOnly) Sets the default "read only" setting for borrowedConnectionsvoidsetDefaultSchema(String defaultSchema) Sets the default "schema" setting for borrowedConnectionsvoidsetDefaultTransactionIsolation(int defaultTransactionIsolation) Sets the default "Transaction Isolation" setting for borrowedConnectionsvoidsetDisconnectionSqlCodes(Collection<String> disconnectionSqlCodes) voidsetEnableAutoCommitOnReturn(boolean autoCommitOnReturn) Deprecated.voidsetFastFailValidation(boolean fastFailValidation) voidsetMaxConn(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(String validationQuery) Sets the query I use tovalidateConnections.voidsetValidationQueryTimeout(int validationQueryTimeoutSeconds) Deprecated.voidsetValidationQueryTimeout(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.voidValidates the given connection if it is open.booleanEnsures that the instance is safe to be returned by the pool.
- 
Constructor Details- 
PoolableConnectionFactoryCreates a newPoolableConnectionFactory.- Parameters:
- connFactory- the- ConnectionFactoryfrom which to obtain base- Connections
- dataSourceJmxObjectName- The JMX object name, may be null.
 
 
- 
- 
Method Details- 
activateObjectDescription copied from interface:PooledObjectFactoryReinitializes an instance to be returned by the pool.- Specified by:
- activateObjectin interface- PooledObjectFactory<PoolableConnection>
- Parameters:
- p- a- PooledObjectwrapping the instance to be activated
- Throws:
- SQLException
- See Also:
 
- 
destroyObjectDescription 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 interface- PooledObjectFactory<PoolableConnection>
- Parameters:
- p- a- PooledObjectwrapping the instance to be destroyed
- Throws:
- SQLException
- See Also:
 
- 
destroyObjectDescription copied from interface:PooledObjectFactoryDestroys an instance no longer needed by the pool, using the provided DestroyMode.- Specified by:
- destroyObjectin interface- PooledObjectFactory<PoolableConnection>
- Parameters:
- p- a- PooledObjectwrapping the instance to be destroyed
- mode- DestroyMode providing context to the factory
- Throws:
- SQLException
- Since:
- 2.9.0
- See Also:
 
- 
getCacheStatepublic boolean getCacheState()Gets the cache state.- Returns:
- The cache state.
- Since:
- 2.6.0.
 
- 
getConnectionFactoryGets the connection factory.- Returns:
- The connection factory.
- Since:
- 2.6.0.
 
- 
getConnectionIndex
- 
getConnectionInitSqls- Returns:
- The collection of initialization SQL statements.
- Since:
- 2.6.0
 
- 
getDataSourceJmxName- Returns:
- The data source JMX ObjectName
- Since:
- 2.6.0.
 
- 
getDataSourceJmxObjectName- Returns:
- The data source JMS ObjectName.
- Since:
- 2.6.0
 
- 
getDefaultAutoCommit- Returns:
- Default auto-commit value.
- Since:
- 2.6.0
 
- 
getDefaultCatalog- Returns:
- Default catalog.
- Since:
- 2.6.0
 
- 
getDefaultQueryTimeoutDeprecated.- Returns:
- Default query timeout in seconds.
 
- 
getDefaultQueryTimeoutDurationGets the default query timeout Duration.- Returns:
- Default query timeout Duration.
- Since:
- 2.10.0
 
- 
getDefaultQueryTimeoutSecondsDeprecated.- Returns:
- Default query timeout in seconds.
- Since:
- 2.6.0
 
- 
getDefaultReadOnly- Returns:
- Default read-only-value.
- Since:
- 2.6.0
 
- 
getDefaultSchema- Returns:
- Default schema.
- Since:
- 2.6.0
 
- 
getDefaultTransactionIsolationpublic int getDefaultTransactionIsolation()- Returns:
- Default transaction isolation.
- Since:
- 2.6.0
 
- 
getDisconnectionSqlCodesSQL_STATE codes considered to signal fatal conditions.Overrides the defaults in Utils.getDisconnectionSqlCodes()(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
 
- 
getMaxConnDurationGets the Maximum connection duration.- Returns:
- Maximum connection duration.
- Since:
- 2.10.0
 
- 
getMaxConnLifetimeMillispublic long getMaxConnLifetimeMillis()Gets the Maximum connection lifetime in milliseconds.- Returns:
- Maximum connection lifetime in milliseconds.
- Since:
- 2.6.0
 
- 
getMaxOpenPreparedStatementsprotected int getMaxOpenPreparedStatements()
- 
getPoolReturns theObjectPoolin whichConnections are pooled.- Returns:
- the connection pool
 
- 
getPoolStatementspublic boolean getPoolStatements()- Returns:
- Whether to pool statements.
- Since:
- 2.6.0.
 
- 
getValidationQuery- Returns:
- Validation query.
- Since:
- 2.6.0
 
- 
getValidationQueryTimeoutDurationGets the query timeout in seconds.- Returns:
- Validation query timeout in seconds.
- Since:
- 2.10.0
 
- 
getValidationQueryTimeoutSecondsDeprecated.Gets the query timeout in seconds.- Returns:
- Validation query timeout in seconds.
- Since:
- 2.6.0
 
- 
initializeConnection- Throws:
- SQLException
 
- 
isAutoCommitOnReturnpublic boolean isAutoCommitOnReturn()- Returns:
- Whether to auto-commit on return.
- Since:
- 2.6.0
 
- 
isEnableAutoCommitOnReturnDeprecated.- Returns:
- Whether to auto-commit on return.
 
- 
isFastFailValidationpublic 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:
 
- 
isRollbackOnReturnpublic boolean isRollbackOnReturn()- Returns:
- Whether to rollback on return.
 
- 
makeObjectDescription 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 interface- PooledObjectFactory<PoolableConnection>
- Returns:
- a PooledObjectwrapping an instance that can be served by the pool, not null.
- Throws:
- SQLException
 
- 
passivateObjectDescription copied from interface:PooledObjectFactoryUninitializes an instance to be returned to the idle object pool.- Specified by:
- passivateObjectin interface- PooledObjectFactory<PoolableConnection>
- Parameters:
- p- a- PooledObjectwrapping the instance to be passivated
- Throws:
- SQLException
- See Also:
 
- 
setAutoCommitOnReturnpublic void setAutoCommitOnReturn(boolean autoCommitOnReturn) 
- 
setCacheStatepublic void setCacheState(boolean cacheState) 
- 
setClearStatementPoolOnReturnpublic 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
 
- 
setConnectionInitSqlSets the SQL statements I use to initialize newly createdConnections. Usingnullturns off connection initialization.- Parameters:
- connectionInitSqls- SQL statement to initialize- Connections.
 
- 
setDefaultAutoCommitSets the default "auto commit" setting for borrowedConnections- Parameters:
- defaultAutoCommit- the default "auto commit" setting for borrowed- Connections
 
- 
setDefaultCatalogSets the default "catalog" setting for borrowedConnections- Parameters:
- defaultCatalog- the default "catalog" setting for borrowed- Connections
 
- 
setDefaultQueryTimeoutSets the query timeout Duration.- Parameters:
- defaultQueryTimeoutDuration- the query timeout Duration.
- Since:
- 2.10.0
 
- 
setDefaultQueryTimeoutDeprecated.Sets the query timeout in seconds.- Parameters:
- defaultQueryTimeoutSeconds- the query timeout in seconds.
 
- 
setDefaultReadOnlySets the default "read only" setting for borrowedConnections- Parameters:
- defaultReadOnly- the default "read only" setting for borrowed- Connections
 
- 
setDefaultSchemaSets the default "schema" setting for borrowedConnections- Parameters:
- defaultSchema- the default "schema" setting for borrowed- Connections
- Since:
- 2.5.0
 
- 
setDefaultTransactionIsolationpublic void setDefaultTransactionIsolation(int defaultTransactionIsolation) Sets the default "Transaction Isolation" setting for borrowedConnections- Parameters:
- defaultTransactionIsolation- the default "Transaction Isolation" setting for returned- Connections
 
- 
setDisconnectionSqlCodes- Parameters:
- disconnectionSqlCodes- The disconnection SQL codes.
- Since:
- 2.1
- See Also:
 
- 
setEnableAutoCommitOnReturnDeprecated.- Parameters:
- autoCommitOnReturn- Whether to auto-commit on return.
 
- 
setFastFailValidationpublic void setFastFailValidation(boolean fastFailValidation) - Parameters:
- fastFailValidation- true means connections created by this factory will fast fail validation
- Since:
- 2.1
- See Also:
 
- 
setMaxConnSets 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
 
- 
setMaxConnLifetimeMillisDeprecated.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.
 
- 
setMaxOpenPreparedStatementspublic void setMaxOpenPreparedStatements(int maxOpenPreparedStatements) Sets the maximum number of open prepared statements.- Parameters:
- maxOpenPreparedStatements- The maximum number of open prepared statements.
 
- 
setMaxOpenPrepatedStatementsDeprecated.Deprecated due to typo in method name.- Parameters:
- maxOpenPreparedStatements- The maximum number of open prepared statements.
 
- 
setPoolSets theObjectPoolin which to poolConnections.- Parameters:
- pool- the- ObjectPoolin which to pool those- Connections
 
- 
setPoolStatementspublic void setPoolStatements(boolean poolStatements) 
- 
setRollbackOnReturnpublic void setRollbackOnReturn(boolean rollbackOnReturn) 
- 
setValidationQuerySets 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 to- validate- Connections.
 
- 
setValidationQueryTimeoutSets 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
 
- 
setValidationQueryTimeoutDeprecated.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
 
- 
validateConnectionValidates the given connection if it is open.- Parameters:
- conn- the connection to validate.
- Throws:
- SQLException- if the connection is closed or validate fails.
 
- 
validateObjectDescription copied from interface:PooledObjectFactoryEnsures that the instance is safe to be returned by the pool.- Specified by:
- validateObjectin interface- PooledObjectFactory<PoolableConnection>
- Parameters:
- p- a- PooledObjectwrapping the instance to be validated
- Returns:
- falseif- objis not valid and should be dropped from the pool,- trueotherwise.
 
 
- 
getDefaultQueryTimeoutDuration().