Package org.apache.tomcat.dbcp.dbcp2

Class PoolableConnectionFactory

java.lang.Object
org.apache.tomcat.dbcp.dbcp2.PoolableConnectionFactory
All Implemented Interfaces:
PooledObjectFactory<PoolableConnection>
public class PoolableConnectionFactory extends Object implements PooledObjectFactory<PoolableConnection>
A PooledObjectFactory that creates PoolableConnections.
Since:
2.0

  • Constructor Details

    • PoolableConnectionFactory

      public PoolableConnectionFactory(ConnectionFactory connFactory, ObjectName dataSourceJmxObjectName)
      Creates a new PoolableConnectionFactory.
      Parameters:
      connFactory - the ConnectionFactory from which to obtain base Connections
      dataSourceJmxObjectName - The JMX object name, may be null.

  • Method Details

    • activateObject

      public void activateObject(PooledObject<PoolableConnection> p) throws Exception
      Description copied from interface: PooledObjectFactory
      Reinitializes an instance to be returned by the pool.
      Specified by:
      activateObject in interface PooledObjectFactory<PoolableConnection>
      Parameters:
      p - a PooledObject wrapping the instance to be activated
      Throws:
      Exception - if there is a problem activating obj, this exception may be swallowed by the pool.
      See Also:

    • destroyObject

      public void destroyObject(PooledObject<PoolableConnection> p) throws Exception
      Description copied from interface: PooledObjectFactory
      Destroys 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 obj will 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:
      destroyObject in interface PooledObjectFactory<PoolableConnection>
      Parameters:
      p - a PooledObject wrapping the instance to be destroyed
      Throws:
      Exception - should be avoided as it may be swallowed by the pool implementation.
      See Also:

    • destroyObject

      public void destroyObject(PooledObject<PoolableConnection> p, DestroyMode mode) throws Exception
      Description copied from interface: PooledObjectFactory
      Destroys an instance no longer needed by the pool, using the provided DestroyMode.
      Specified by:
      destroyObject in interface PooledObjectFactory<PoolableConnection>
      Parameters:
      p - a PooledObject wrapping the instance to be destroyed
      mode - DestroyMode providing context to the factory
      Throws:
      Exception - should be avoided as it may be swallowed by the pool implementation.
      Since:
      2.9.0
      See Also:

    • getCacheState

      public boolean getCacheState()
      Returns:
      The cache state.
      Since:
      Made public in 2.6.0.

    • getConnectionFactory

      public ConnectionFactory getConnectionFactory()
      Returns:
      The connection factory.
      Since:
      Made public in 2.6.0.

    • getConnectionIndex

      protected AtomicLong getConnectionIndex()

    • getConnectionInitSqls

      public Collection<String> getConnectionInitSqls()
      Returns:
      The collection of initialization SQL statements.
      Since:
      2.6.0

    • getDataSourceJmxName

      public ObjectName getDataSourceJmxName()
      Returns:
      The data source JMX ObjectName
      Since:
      Made public in 2.6.0.

    • getDataSourceJmxObjectName

      public ObjectName getDataSourceJmxObjectName()
      Returns:
      The data source JMS ObjectName.
      Since:
      2.6.0

    • getDefaultAutoCommit

      public Boolean getDefaultAutoCommit()
      Returns:
      Default auto-commit value.
      Since:
      2.6.0

    • getDefaultCatalog

      public String getDefaultCatalog()
      Returns:
      Default catalog.
      Since:
      2.6.0

    • getDefaultQueryTimeout

      public Integer getDefaultQueryTimeout()
      Returns:
      Default query timeout in seconds.

    • getDefaultQueryTimeoutSeconds

      public Integer getDefaultQueryTimeoutSeconds()
      Returns:
      Default query timeout in seconds.
      Since:
      2.6.0

    • getDefaultReadOnly

      public Boolean getDefaultReadOnly()
      Returns:
      Default read-only-value.
      Since:
      2.6.0

    • getDefaultSchema

      public String getDefaultSchema()
      Returns:
      Default schema.
      Since:
      2.6.0

    • getDefaultTransactionIsolation

      public int getDefaultTransactionIsolation()
      Returns:
      Default transaction isolation.
      Since:
      2.6.0

    • getDisconnectionSqlCodes

      public Collection<String> getDisconnectionSqlCodes()
      SQL_STATE codes considered to signal fatal conditions.

      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.

      Returns:
      SQL_STATE codes overriding defaults
      Since:
      2.1

    • getMaxConnLifetimeMillis

      public long getMaxConnLifetimeMillis()
      Returns:
      Maximum connection lifetime in milliseconds.
      Since:
      2.6.0

    • getMaxOpenPreparedStatements

      protected int getMaxOpenPreparedStatements()

    • getPool

      public ObjectPool<PoolableConnection> getPool()
      Returns the ObjectPool in which Connections are pooled.
      Returns:
      the connection pool

    • getPoolStatements

      public boolean getPoolStatements()
      Returns:
      Whether to pool statements.
      Since:
      Made public in 2.6.0.

    • getValidationQuery

      public String getValidationQuery()
      Returns:
      Validation query.
      Since:
      2.6.0

    • getValidationQueryTimeoutSeconds

      public int getValidationQueryTimeoutSeconds()
      Returns:
      Validation query timeout in seconds.
      Since:
      2.6.0

    • initializeConnection

      protected void initializeConnection(Connection conn) throws SQLException
      Throws:
      SQLException

    • isAutoCommitOnReturn

      public boolean isAutoCommitOnReturn()
      Returns:
      Whether to auto-commit on return.
      Since:
      2.6.0

    • isEnableAutoCommitOnReturn

      @Deprecated public boolean isEnableAutoCommitOnReturn()
      Deprecated.
      Use isAutoCommitOnReturn().
      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:

    • isRollbackOnReturn

      public boolean isRollbackOnReturn()
      Returns:
      Whether to rollback on return.

    • makeObject

      public PooledObject<PoolableConnection> makeObject() throws Exception
      Description copied from interface: PooledObjectFactory
      Creates an instance that can be served by the pool and wrap it in a PooledObject to be managed by the pool.
      Specified by:
      makeObject in interface PooledObjectFactory<PoolableConnection>
      Returns:
      a PooledObject wrapping an instance that can be served by the pool
      Throws:
      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 Exception
      Description copied from interface: PooledObjectFactory
      Uninitializes an instance to be returned to the idle object pool.
      Specified by:
      passivateObject in interface PooledObjectFactory<PoolableConnection>
      Parameters:
      p - a PooledObject wrapping the instance to be passivated
      Throws:
      Exception - if there is a problem passivating obj, this exception may be swallowed by the pool.
      See Also:

    • 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 with setPoolStatements(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(Collection<String> connectionInitSqls)
      Sets the SQL statements I use to initialize newly created Connections. Using null turns off connection initialization.
      Parameters:
      connectionInitSqls - SQL statement to initialize Connections.

    • setDefaultAutoCommit

      public void setDefaultAutoCommit(Boolean defaultAutoCommit)
      Sets the default "auto commit" setting for borrowed Connections
      Parameters:
      defaultAutoCommit - the default "auto commit" setting for borrowed Connections

    • setDefaultCatalog

      public void setDefaultCatalog(String defaultCatalog)
      Sets the default "catalog" setting for borrowed Connections
      Parameters:
      defaultCatalog - the default "catalog" setting for borrowed Connections

    • setDefaultQueryTimeout

      public void setDefaultQueryTimeout(Integer defaultQueryTimeoutSeconds)

    • setDefaultReadOnly

      public void setDefaultReadOnly(Boolean defaultReadOnly)
      Sets the default "read only" setting for borrowed Connections
      Parameters:
      defaultReadOnly - the default "read only" setting for borrowed Connections

    • setDefaultSchema

      public void setDefaultSchema(String defaultSchema)
      Sets the default "schema" setting for borrowed Connections
      Parameters:
      defaultSchema - the default "schema" setting for borrowed Connections
      Since:
      2.5.0

    • setDefaultTransactionIsolation

      public void setDefaultTransactionIsolation(int defaultTransactionIsolation)
      Sets the default "Transaction Isolation" setting for borrowed Connections
      Parameters:
      defaultTransactionIsolation - the default "Transaction Isolation" setting for returned Connections

    • setDisconnectionSqlCodes

      public void setDisconnectionSqlCodes(Collection<String> disconnectionSqlCodes)
      Parameters:
      disconnectionSqlCodes - The disconnection SQL codes.
      Since:
      2.1
      See Also:

    • setEnableAutoCommitOnReturn

      @Deprecated public void setEnableAutoCommitOnReturn(boolean autoCommitOnReturn)
      Deprecated.
      Use setAutoCommitOnReturn(boolean).
      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:

    • setMaxConnLifetimeMillis

      public void setMaxConnLifetimeMillis(long maxConnLifetimeMillis)
      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.
      Use setMaxOpenPreparedStatements(int).
      Deprecated due to typo in method name.
      Parameters:
      maxOpenPreparedStatements - The maximum number of open prepared statements.

    • setPool

      public void setPool(ObjectPool<PoolableConnection> pool)
      Sets the ObjectPool in which to pool Connections.
      Parameters:
      pool - the ObjectPool in which to pool those Connections

    • setPoolStatements

      public void setPoolStatements(boolean poolStatements)

    • setRollbackOnReturn

      public void setRollbackOnReturn(boolean rollbackOnReturn)

    • setValidationQuery

      public void setValidationQuery(String validationQuery)
      Sets the query I use to validate Connections. 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.

    • setValidationQueryTimeout

      public void setValidationQueryTimeout(int validationQueryTimeoutSeconds)
      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 SQLException
      Throws:
      SQLException

    • validateObject

      public boolean validateObject(PooledObject<PoolableConnection> p)
      Description copied from interface: PooledObjectFactory
      Ensures that the instance is safe to be returned by the pool.
      Specified by:
      validateObject in interface PooledObjectFactory<PoolableConnection>
      Parameters:
      p - a PooledObject wrapping the instance to be validated
      Returns:
      false if obj is not valid and should be dropped from the pool, true otherwise.