org.apache.commons.dbcp

Class PoolableConnectionFactory

public class PoolableConnectionFactory extends Object implements PoolableObjectFactory

A PoolableObjectFactory that creates PoolableConnections.

Version: $Revision: 479187 $ $Date: 2006-11-25 13:13:45 -0700 (Sat, 25 Nov 2006) $

Author: Rodney Waldhoff Glenn L. Nielsen James House Dirk Verbeeck

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, int defaultTransactionIsolation)
Create a new PoolableConnectionFactory.
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit, AbandonedConfig config)
Create a new PoolableConnectionFactory.
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation, AbandonedConfig config)
Create a new PoolableConnectionFactory.
PoolableConnectionFactory(ConnectionFactory connFactory, ObjectPool pool, KeyedObjectPoolFactory stmtPoolFactory, String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation, String defaultCatalog, AbandonedConfig config)
Create a new PoolableConnectionFactory.
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
voidactivateObject(Object obj)
voiddestroyObject(Object obj)
ObjectPoolgetPool()
ObjectmakeObject()
voidpassivateObject(Object obj)
voidsetConnectionFactory(ConnectionFactory connFactory)
Sets the ConnectionFactory from which to obtain base Connections.
voidsetDefaultAutoCommit(boolean defaultAutoCommit)
Sets the default "auto commit" setting for borrowed Connections
voidsetDefaultCatalog(String defaultCatalog)
Sets the default "catalog" setting for borrowed Connections
voidsetDefaultReadOnly(boolean defaultReadOnly)
Sets the default "read only" setting for borrowed Connections
voidsetDefaultTransactionIsolation(int defaultTransactionIsolation)
Sets the default "Transaction Isolation" setting for borrowed Connections
voidsetPool(ObjectPool pool)
Sets the ObjectPool in which to pool Connections.
voidsetStatementPoolFactory(KeyedObjectPoolFactory stmtPoolFactory)
Sets the KeyedObjectPoolFactory I use to create KeyedObjectPools for pooling java.sql.PreparedStatements.
voidsetValidationQuery(String validationQuery)
Sets the query I use to validate Connections.
voidvalidateConnection(Connection conn)
booleanvalidateObject(Object obj)

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 java.sql.PreparedStatements, or null to disable java.sql.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 java.sql.PreparedStatements, or null to disable java.sql.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 java.sql.PreparedStatements, or null to disable java.sql.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 java.sql.PreparedStatements, or null to disable java.sql.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 java.sql.PreparedStatements, or null to disable java.sql.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 java.sql.PreparedStatements, or null to disable java.sql.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

activateObject

public void activateObject(Object obj)

destroyObject

public void destroyObject(Object obj)

getPool

public ObjectPool getPool()

makeObject

public Object makeObject()

passivateObject

public void passivateObject(Object obj)

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

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

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

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

setPool

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

Parameters: pool the ObjectPool in which to pool those Connections

setStatementPoolFactory

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

Parameters: stmtPoolFactory the KeyedObjectPoolFactory to use to create KeyedObjectPools for pooling java.sql.PreparedStatements

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.

validateConnection

public void validateConnection(Connection conn)

validateObject

public boolean validateObject(Object obj)
Copyright © 2001-2004 Apache Software Foundation. Documenation generated December 10 2007.