Overview  Package   Class  Index 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.dbcp
Class PoolableConnectionFactory

java.lang.Object
  extended by org.apache.commons.dbcp.PoolableConnectionFactory
All Implemented Interfaces:
org.apache.commons.pool.PoolableObjectFactory
public class PoolableConnectionFactory
extends java.lang.Object
implements org.apache.commons.pool.PoolableObjectFactory

A PoolableObjectFactory that creates PoolableConnections.

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, org.apache.commons.pool.ObjectPool pool, org.apache.commons.pool.KeyedObjectPoolFactory stmtPoolFactory, java.lang.String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit)
          Create a new PoolableConnectionFactory.
PoolableConnectionFactory(ConnectionFactory connFactory, org.apache.commons.pool.ObjectPool pool, org.apache.commons.pool.KeyedObjectPoolFactory stmtPoolFactory, java.lang.String validationQuery, boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation)
          Create a new PoolableConnectionFactory.
PoolableConnectionFactory(ConnectionFactory connFactory, org.apache.commons.pool.ObjectPool pool, org.apache.commons.pool.KeyedObjectPoolFactory stmtPoolFactory, java.lang.String validationQuery, java.lang.Boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation, java.lang.String defaultCatalog, org.apache.commons.dbcp.AbandonedConfig config)
          Create a new PoolableConnectionFactory.
 
Method Summary
 void activateObject(java.lang.Object obj)
           
 void destroyObject(java.lang.Object obj)
           
 org.apache.commons.pool.ObjectPool getPool()
           
 java.lang.Object makeObject()
           
 void passivateObject(java.lang.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(java.lang.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(org.apache.commons.pool.ObjectPool pool)
          Sets the ObjectPool in which to pool Connections.
 void setStatementPoolFactory(org.apache.commons.pool.KeyedObjectPoolFactory stmtPoolFactory)
          Sets the KeyedObjectPoolFactory I use to create KeyedObjectPools for pooling PreparedStatements.
 void setValidationQuery(java.lang.String validationQuery)
          Sets the query I use to validate Connections.
 void validateConnection(java.sql.Connection conn)
           
 boolean validateObject(java.lang.Object obj)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PoolableConnectionFactory

public PoolableConnectionFactory(ConnectionFactory connFactory,
                                 org.apache.commons.pool.ObjectPool pool,
                                 org.apache.commons.pool.KeyedObjectPoolFactory stmtPoolFactory,
                                 java.lang.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,
                                 org.apache.commons.pool.ObjectPool pool,
                                 org.apache.commons.pool.KeyedObjectPoolFactory stmtPoolFactory,
                                 java.lang.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,
                                 org.apache.commons.pool.ObjectPool pool,
                                 org.apache.commons.pool.KeyedObjectPoolFactory stmtPoolFactory,
                                 java.lang.String validationQuery,
                                 java.lang.Boolean defaultReadOnly,
                                 boolean defaultAutoCommit,
                                 int defaultTransactionIsolation,
                                 java.lang.String defaultCatalog,
                                 org.apache.commons.dbcp.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

activateObject

public void activateObject(java.lang.Object obj)
                    throws java.lang.Exception
Specified by:
activateObject in interface org.apache.commons.pool.PoolableObjectFactory
Throws:
java.lang.Exception

destroyObject

public void destroyObject(java.lang.Object obj)
                   throws java.lang.Exception
Specified by:
destroyObject in interface org.apache.commons.pool.PoolableObjectFactory
Throws:
java.lang.Exception

getPool

public org.apache.commons.pool.ObjectPool getPool()

makeObject

public java.lang.Object makeObject()
                            throws java.lang.Exception
Specified by:
makeObject in interface org.apache.commons.pool.PoolableObjectFactory
Throws:
java.lang.Exception

passivateObject

public void passivateObject(java.lang.Object obj)
                     throws java.lang.Exception
Specified by:
passivateObject in interface org.apache.commons.pool.PoolableObjectFactory
Throws:
java.lang.Exception

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(java.lang.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(org.apache.commons.pool.ObjectPool pool)
Sets the ObjectPool in which to pool Connections.

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

setStatementPoolFactory

public void setStatementPoolFactory(org.apache.commons.pool.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

setValidationQuery

public void setValidationQuery(java.lang.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(java.sql.Connection conn)
                        throws java.sql.SQLException
Throws:
java.sql.SQLException

validateObject

public boolean validateObject(java.lang.Object obj)
Specified by:
validateObject in interface org.apache.commons.pool.PoolableObjectFactory
Overview  Package   Class  Index 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2001-2003 Apache Software Foundation. Documenation generated August 20 2009.