org.apache.commons.dbcp
Class PoolableConnectionFactory

java.lang.Object
  extended byorg.apache.commons.dbcp.PoolableConnectionFactory
All Implemented Interfaces:
PoolableObjectFactory

public class PoolableConnectionFactory
extends Object
implements PoolableObjectFactory

A PoolableObjectFactory that creates PoolableConnections.

Version:
$Revision: 892307 $ $Date: 2014-01-01 00:27:28 +0100 (Wed, 01 Jan 2014) $
Author:
Rodney Waldhoff, Glenn L. Nielsen, James House, Dirk Verbeeck

Field Summary
protected  AbandonedConfig _config
          Deprecated. AbandonedConfig is now deprecated.
protected  ConnectionFactory _connFactory
           
protected  boolean _defaultAutoCommit
           
protected  String _defaultCatalog
           
protected  Boolean _defaultReadOnly
           
protected  int _defaultTransactionIsolation
           
protected  ObjectPool _pool
           
protected  KeyedObjectPoolFactory _stmtPoolFactory
           
protected  String _validationQuery
           
 
Constructor Summary
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit)
          Create a new PoolableConnectionFactory.
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit, AbandonedConfig config)
          Deprecated. AbandonedConfig is now deprecated.
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation)
          Create a new PoolableConnectionFactory.
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation, AbandonedConfig config)
          Deprecated. AbandonedConfig is now deprecated.
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation, String defaultCatalog, AbandonedConfig config)
          Deprecated. AbandonedConfig is now deprecated.
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, Boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation, String defaultCatalog, AbandonedConfig config)
          Create a new PoolableConnectionFactory.
 
Method Summary
 void activateObject(Object obj)
           
 void destroyObject(Object obj)
           
 ObjectPool getPool()
           
 Object makeObject()
           
 void passivateObject(Object obj)
           
 void setConnectionFactory(ConnectionFactory connFactory)
          Sets the ConnectionFactory from which to obtain base Connections.
 void setDefaultAutoCommit(boolean defaultAutoCommit)
          Sets the default "auto commit" setting for borrowed Connections
 void setDefaultCatalog(String defaultCatalog)
          Sets the default "catalog" setting for borrowed Connections
 void setDefaultReadOnly(boolean defaultReadOnly)
          Sets the default "read only" setting for borrowed Connections
 void setDefaultTransactionIsolation(int defaultTransactionIsolation)
          Sets the default "Transaction Isolation" setting for borrowed Connections
 void setPool(ObjectPool pool)
          Sets the ObjectPool in which to pool Connections.
 void setStatementPoolFactory(KeyedObjectPoolFactory stmtPoolFactory)
          Sets the KeyedObjectPoolFactory I use to create KeyedObjectPools for pooling PreparedStatements.
 void setValidationQuery(String validationQuery)
          Sets the query I use to validate Connections.
 void validateConnection(Connection conn)
           
 boolean validateObject(Object obj)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_connFactory

protected ConnectionFactory _connFactory

_validationQuery

protected String _validationQuery

_pool

protected ObjectPool _pool

_stmtPoolFactory

protected KeyedObjectPoolFactory _stmtPoolFactory

_defaultReadOnly

protected Boolean _defaultReadOnly

_defaultAutoCommit

protected boolean _defaultAutoCommit

_defaultTransactionIsolation

protected int _defaultTransactionIsolation

_defaultCatalog

protected String _defaultCatalog

_config

protected AbandonedConfig _config
Deprecated. AbandonedConfig is now deprecated.

Constructor Detail

PoolableConnectionFactory

public PoolableConnectionFactory(ConnectionFactory connFactory,
                                 ObjectPool pool,
                                 KeyedObjectPoolFactory stmtPoolFactory,
                                 String validationQuery,
                                 boolean defaultReadOnly,
                                 boolean defaultAutoCommit)
Create a new PoolableConnectionFactory.

Parameters:
connFactory - the ConnectionFactory from which to obtain base Connections
pool - the ObjectPool in which to pool those Connections
stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPools for pooling PreparedStatements, or null to disable PreparedStatement pooling
validationQuery - a query to use to validate Connections. Should return at least one row. Using null turns off validation.
defaultReadOnly - the default "read only" setting for borrowed Connections
defaultAutoCommit - the default "auto commit" setting for returned Connections

PoolableConnectionFactory

public PoolableConnectionFactory(ConnectionFactory connFactory,
                                 ObjectPool pool,
                                 KeyedObjectPoolFactory stmtPoolFactory,
                                 String validationQuery,
                                 boolean defaultReadOnly,
                                 boolean defaultAutoCommit,
                                 int defaultTransactionIsolation)
Create a new PoolableConnectionFactory.

Parameters:
connFactory - the ConnectionFactory from which to obtain base Connections
pool - the ObjectPool in which to pool those Connections
stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPools for pooling PreparedStatements, or null to disable PreparedStatement pooling
validationQuery - a query to use to validate Connections. Should return at least one row. Using null turns off validation.
defaultReadOnly - the default "read only" setting for borrowed Connections
defaultAutoCommit - the default "auto commit" setting for returned Connections
defaultTransactionIsolation - the default "Transaction Isolation" setting for returned Connections

PoolableConnectionFactory

public PoolableConnectionFactory(ConnectionFactory connFactory,
                                 ObjectPool pool,
                                 KeyedObjectPoolFactory stmtPoolFactory,
                                 String validationQuery,
                                 boolean defaultReadOnly,
                                 boolean defaultAutoCommit,
                                 AbandonedConfig config)
Deprecated. AbandonedConfig is now deprecated.

Create a new PoolableConnectionFactory.

Parameters:
connFactory - the ConnectionFactory from which to obtain base Connections
pool - the ObjectPool in which to pool those Connections
stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPools for pooling PreparedStatements, or null to disable PreparedStatement pooling
validationQuery - a query to use to validate Connections. Should return at least one row. Using null turns off validation.
defaultReadOnly - the default "read only" setting for borrowed Connections
defaultAutoCommit - the default "auto commit" setting for returned Connections
config - the AbandonedConfig if tracing SQL objects

PoolableConnectionFactory

public PoolableConnectionFactory(ConnectionFactory connFactory,
                                 ObjectPool pool,
                                 KeyedObjectPoolFactory stmtPoolFactory,
                                 String validationQuery,
                                 boolean defaultReadOnly,
                                 boolean defaultAutoCommit,
                                 int defaultTransactionIsolation,
                                 AbandonedConfig config)
Deprecated. AbandonedConfig is now deprecated.

Create a new PoolableConnectionFactory.

Parameters:
connFactory - the ConnectionFactory from which to obtain base Connections
pool - the ObjectPool in which to pool those Connections
stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPools for pooling PreparedStatements, or null to disable PreparedStatement pooling
validationQuery - a query to use to validate Connections. Should return at least one row. Using null turns off validation.
defaultReadOnly - the default "read only" setting for borrowed Connections
defaultAutoCommit - the default "auto commit" setting for returned Connections
defaultTransactionIsolation - the default "Transaction Isolation" setting for returned Connections
config - the AbandonedConfig if tracing SQL objects

PoolableConnectionFactory

public PoolableConnectionFactory(ConnectionFactory connFactory,
                                 ObjectPool pool,
                                 KeyedObjectPoolFactory stmtPoolFactory,
                                 String validationQuery,
                                 boolean defaultReadOnly,
                                 boolean defaultAutoCommit,
                                 int defaultTransactionIsolation,
                                 String defaultCatalog,
                                 AbandonedConfig config)
Deprecated. AbandonedConfig is now deprecated.

Create a new PoolableConnectionFactory.

Parameters:
connFactory - the ConnectionFactory from which to obtain base Connections
pool - the ObjectPool in which to pool those Connections
stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPools for pooling PreparedStatements, or null to disable PreparedStatement pooling
validationQuery - a query to use to validate Connections. Should return at least one row. Using null turns off validation.
defaultReadOnly - the default "read only" setting for borrowed Connections
defaultAutoCommit - the default "auto commit" setting for returned Connections
defaultTransactionIsolation - the default "Transaction Isolation" setting for returned Connections
defaultCatalog - the default "catalog" setting for returned Connections
config - the AbandonedConfig if tracing SQL objects

PoolableConnectionFactory

public PoolableConnectionFactory(ConnectionFactory connFactory,
                                 ObjectPool pool,
                                 KeyedObjectPoolFactory stmtPoolFactory,
                                 String validationQuery,
                                 Boolean defaultReadOnly,
                                 boolean defaultAutoCommit,
                                 int defaultTransactionIsolation,
                                 String defaultCatalog,
                                 AbandonedConfig config)
Create a new PoolableConnectionFactory.

Parameters:
connFactory - the ConnectionFactory from which to obtain base Connections
pool - the ObjectPool in which to pool those Connections
stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPools for pooling PreparedStatements, or null to disable PreparedStatement pooling
validationQuery - a query to use to validate Connections. Should return at least one row. Using null turns off validation.
defaultReadOnly - the default "read only" setting for borrowed Connections
defaultAutoCommit - the default "auto commit" setting for returned Connections
defaultTransactionIsolation - the default "Transaction Isolation" setting for returned Connections
defaultCatalog - the default "catalog" setting for returned Connections
config - the AbandonedConfig if tracing SQL objects
Method Detail

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connFactory)
Sets the ConnectionFactory from which to obtain base Connections.

Parameters:
connFactory - the ConnectionFactory from which to obtain base Connections

setValidationQuery

public void setValidationQuery(String validationQuery)
Sets the query I use to validate Connections. Should return at least one row. Using null turns off validation.

Parameters:
validationQuery - a query to use to validate Connections.

setPool

public void setPool(ObjectPool pool)
Sets the ObjectPool in which to pool Connections.

Parameters:
pool - the ObjectPool in which to pool those Connections

getPool

public ObjectPool getPool()

setStatementPoolFactory

public void setStatementPoolFactory(KeyedObjectPoolFactory stmtPoolFactory)
Sets the KeyedObjectPoolFactory I use to create KeyedObjectPools for pooling PreparedStatements. Set to null to disable PreparedStatement pooling.

Parameters:
stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPools for pooling PreparedStatements

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

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

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

setDefaultCatalog

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

Parameters:
defaultCatalog - the default "catalog" setting for borrowed Connections

makeObject

public Object makeObject()
                  throws Exception
Specified by:
makeObject in interface PoolableObjectFactory
Throws:
Exception

destroyObject

public void destroyObject(Object obj)
                   throws Exception
Specified by:
destroyObject in interface PoolableObjectFactory
Throws:
Exception

validateObject

public boolean validateObject(Object obj)
Specified by:
validateObject in interface PoolableObjectFactory

validateConnection

public void validateConnection(Connection conn)
                        throws SQLException
Throws:
SQLException

passivateObject

public void passivateObject(Object obj)
                     throws Exception
Specified by:
passivateObject in interface PoolableObjectFactory
Throws:
Exception

activateObject

public void activateObject(Object obj)
                    throws Exception
Specified by:
activateObject in interface PoolableObjectFactory
Throws:
Exception


Copyright © The Apache Software Foundation. All Rights Reserved.