org.apache.commons.dbcp

Class PoolableConnectionFactory

public class PoolableConnectionFactory extends Object implements PoolableObjectFactory

A {@link PoolableObjectFactory} that creates {@link PoolableConnection}s.

Version: $Revision: 1.23 $ $Date: 2004/06/09 18:21:23 $

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 {@link ConnectionFactory} from which to obtain base {@link Connection}s.
voidsetDefaultAutoCommit(boolean defaultAutoCommit)
Sets the default "auto commit" setting for borrowed {@link Connection}s
voidsetDefaultCatalog(String defaultCatalog)
Sets the default "catalog" setting for borrowed {@link Connection}s
voidsetDefaultReadOnly(boolean defaultReadOnly)
Sets the default "read only" setting for borrowed {@link Connection}s
voidsetDefaultTransactionIsolation(int defaultTransactionIsolation)
Sets the default "Transaction Isolation" setting for borrowed {@link Connection}s
voidsetPool(ObjectPool pool)
Sets the {@link ObjectPool} in which to pool {@link Connection}s.
voidsetStatementPoolFactory(KeyedObjectPoolFactory stmtPoolFactory)
Sets the {@link KeyedObjectPoolFactory} I use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s.
voidsetValidationQuery(String validationQuery)
Sets the query I use to {@link #validateObject validate} {@link Connection}s.
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 {@link ConnectionFactory} from which to obtain base {@link Connection}s pool the {@link ObjectPool} in which to pool those {@link Connection}s stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s, or null to disable {@link java.sql.PreparedStatement} pooling validationQuery a query to use to {@link #validateObject validate} {@link Connection}s. Should return at least one row. Using null turns off validation. defaultReadOnly the default "read only" setting for borrowed {@link Connection}s defaultAutoCommit the default "auto commit" setting for returned {@link Connection}s

PoolableConnectionFactory

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

Parameters: connFactory the {@link ConnectionFactory} from which to obtain base {@link Connection}s pool the {@link ObjectPool} in which to pool those {@link Connection}s stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s, or null to disable {@link java.sql.PreparedStatement} pooling validationQuery a query to use to {@link #validateObject validate} {@link Connection}s. Should return at least one row. Using null turns off validation. defaultReadOnly the default "read only" setting for borrowed {@link Connection}s defaultAutoCommit the default "auto commit" setting for returned {@link Connection}s defaultTransactionIsolation the default "Transaction Isolation" setting for returned {@link Connection}s

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 {@link ConnectionFactory} from which to obtain base {@link Connection}s pool the {@link ObjectPool} in which to pool those {@link Connection}s stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s, or null to disable {@link java.sql.PreparedStatement} pooling validationQuery a query to use to {@link #validateObject validate} {@link Connection}s. Should return at least one row. Using null turns off validation. defaultReadOnly the default "read only" setting for borrowed {@link Connection}s defaultAutoCommit the default "auto commit" setting for returned {@link Connection}s 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 {@link ConnectionFactory} from which to obtain base {@link Connection}s pool the {@link ObjectPool} in which to pool those {@link Connection}s stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s, or null to disable {@link java.sql.PreparedStatement} pooling validationQuery a query to use to {@link #validateObject validate} {@link Connection}s. Should return at least one row. Using null turns off validation. defaultReadOnly the default "read only" setting for borrowed {@link Connection}s defaultAutoCommit the default "auto commit" setting for returned {@link Connection}s defaultTransactionIsolation the default "Transaction Isolation" setting for returned {@link Connection}s 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 {@link ConnectionFactory} from which to obtain base {@link Connection}s pool the {@link ObjectPool} in which to pool those {@link Connection}s stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s, or null to disable {@link java.sql.PreparedStatement} pooling validationQuery a query to use to {@link #validateObject validate} {@link Connection}s. Should return at least one row. Using null turns off validation. defaultReadOnly the default "read only" setting for borrowed {@link Connection}s defaultAutoCommit the default "auto commit" setting for returned {@link Connection}s defaultTransactionIsolation the default "Transaction Isolation" setting for returned {@link Connection}s defaultCatalog the default "catalog" setting for returned {@link Connection}s 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 {@link ConnectionFactory} from which to obtain base {@link Connection}s pool the {@link ObjectPool} in which to pool those {@link Connection}s stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s, or null to disable {@link java.sql.PreparedStatement} pooling validationQuery a query to use to {@link #validateObject validate} {@link Connection}s. Should return at least one row. Using null turns off validation. defaultReadOnly the default "read only" setting for borrowed {@link Connection}s defaultAutoCommit the default "auto commit" setting for returned {@link Connection}s defaultTransactionIsolation the default "Transaction Isolation" setting for returned {@link Connection}s defaultCatalog the default "catalog" setting for returned {@link Connection}s 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 {@link ConnectionFactory} from which to obtain base {@link Connection}s.

Parameters: connFactory the {@link ConnectionFactory} from which to obtain base {@link Connection}s

setDefaultAutoCommit

public void setDefaultAutoCommit(boolean defaultAutoCommit)
Sets the default "auto commit" setting for borrowed {@link Connection}s

Parameters: defaultAutoCommit the default "auto commit" setting for borrowed {@link Connection}s

setDefaultCatalog

public void setDefaultCatalog(String defaultCatalog)
Sets the default "catalog" setting for borrowed {@link Connection}s

Parameters: defaultCatalog the default "catalog" setting for borrowed {@link Connection}s

setDefaultReadOnly

public void setDefaultReadOnly(boolean defaultReadOnly)
Sets the default "read only" setting for borrowed {@link Connection}s

Parameters: defaultReadOnly the default "read only" setting for borrowed {@link Connection}s

setDefaultTransactionIsolation

public void setDefaultTransactionIsolation(int defaultTransactionIsolation)
Sets the default "Transaction Isolation" setting for borrowed {@link Connection}s

Parameters: defaultTransactionIsolation the default "Transaction Isolation" setting for returned {@link Connection}s

setPool

public void setPool(ObjectPool pool)
Sets the {@link ObjectPool} in which to pool {@link Connection}s.

Parameters: pool the {@link ObjectPool} in which to pool those {@link Connection}s

setStatementPoolFactory

public void setStatementPoolFactory(KeyedObjectPoolFactory stmtPoolFactory)
Sets the {@link KeyedObjectPoolFactory} I use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s. Set to null to disable {@link java.sql.PreparedStatement} pooling.

Parameters: stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s

setValidationQuery

public void setValidationQuery(String validationQuery)
Sets the query I use to {@link #validateObject validate} {@link Connection}s. Should return at least one row. Using null turns off validation.

Parameters: validationQuery a query to use to {@link #validateObject validate} {@link Connection}s.

validateConnection

public void validateConnection(Connection conn)

validateObject

public boolean validateObject(Object obj)
Copyright © 2001-2003 Apache Software Foundation. Documenation generated April 25 2007.