Save This Page
Home » commons-dbcp-1.4-src » org.apache.commons » dbcp » [javadoc | source]
org.apache.commons.dbcp
public class: PoolableConnectionFactory [javadoc | source]
java.lang.Object
   org.apache.commons.dbcp.PoolableConnectionFactory

All Implemented Interfaces:
    PoolableObjectFactory

Direct Known Subclasses:
    PoolableManagedConnectionFactory

A PoolableObjectFactory that creates PoolableConnection s.
Field Summary
protected volatile  ConnectionFactory _connFactory     
protected volatile  String _validationQuery     
protected volatile  int _validationQueryTimeout     
protected  Collection _connectionInitSqls     
protected volatile  ObjectPool _pool     
protected volatile  KeyedObjectPoolFactory _stmtPoolFactory     
protected  Boolean _defaultReadOnly     
protected  boolean _defaultAutoCommit     
protected  int _defaultTransactionIsolation     
protected  String _defaultCatalog     
protected  AbandonedConfig _config    Configuration for removing abandoned connections. 
static final  int UNKNOWN_TRANSACTIONISOLATION    Internal constant to indicate the level is not set. 
Constructor:
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    boolean defaultReadOnly,
    boolean defaultAutoCommit) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    Collection connectionInitSqls,
    boolean defaultReadOnly,
    boolean defaultAutoCommit) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    int validationQueryTimeout,
    boolean defaultReadOnly,
    boolean defaultAutoCommit) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    boolean defaultReadOnly,
    boolean defaultAutoCommit,
    AbandonedConfig config) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    int validationQueryTimeout,
    Collection connectionInitSqls,
    boolean defaultReadOnly,
    boolean defaultAutoCommit) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    Collection connectionInitSqls,
    boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    int validationQueryTimeout,
    boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation,
    AbandonedConfig config) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    int validationQueryTimeout,
    Collection connectionInitSqls,
    boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation) 
    Create a new PoolableConnectionFactory.
    Parameters:
    connFactory - the ConnectionFactory from which to obtain base Connection s
    pool - the ObjectPool in which to pool those Connection s
    stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPool s for pooling java.sql.PreparedStatement s, or null to disable java.sql.PreparedStatement pooling
    validationQuery - a query to use to validate Connection s. Should return at least one row. Using null turns off validation.
    validationQueryTimeout - the number of seconds that validation queries will wait for database response before failing. Use a value less than or equal to 0 for no timeout.
    connectionInitSqls - a Collection of SQL statement to initialize Connection s. Using null turns off initialization.
    defaultReadOnly - the default "read only" setting for borrowed Connection s
    defaultAutoCommit - the default "auto commit" setting for returned Connection s
    defaultTransactionIsolation - the default "Transaction Isolation" setting for returned Connection s
    since: 1.3 -
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation,
    String defaultCatalog,
    AbandonedConfig config) 
    Create a new 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.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    Collection connectionInitSqls,
    Boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation,
    String defaultCatalog,
    AbandonedConfig config) 
    Create a new PoolableConnectionFactory.
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    int validationQueryTimeout,
    Boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation,
    String defaultCatalog,
    AbandonedConfig config) 
    Create a new PoolableConnectionFactory.
    Parameters:
    connFactory - the ConnectionFactory from which to obtain base Connection s
    pool - the ObjectPool in which to pool those Connection s
    stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPool s for pooling java.sql.PreparedStatement s, or null to disable java.sql.PreparedStatement pooling
    validationQuery - a query to use to validate Connection s. Should return at least one row. Using null turns off validation.
    validationQueryTimeout - the number of seconds that validation queries will wait for database response before failing. Use a value less than or equal to 0 for no timeout.
    defaultReadOnly - the default "read only" setting for borrowed Connection s
    defaultAutoCommit - the default "auto commit" setting for returned Connection s
    defaultTransactionIsolation - the default "Transaction Isolation" setting for returned Connection s
    defaultCatalog - the default "catalog" setting for returned Connection s
    config - the AbandonedConfig if tracing SQL objects
    since: 1.3 -
 public PoolableConnectionFactory(ConnectionFactory connFactory,
    ObjectPool pool,
    KeyedObjectPoolFactory stmtPoolFactory,
    String validationQuery,
    int validationQueryTimeout,
    Collection connectionInitSqls,
    Boolean defaultReadOnly,
    boolean defaultAutoCommit,
    int defaultTransactionIsolation,
    String defaultCatalog,
    AbandonedConfig config) 
    Create a new PoolableConnectionFactory.
    Parameters:
    connFactory - the ConnectionFactory from which to obtain base Connection s
    pool - the ObjectPool in which to pool those Connection s
    stmtPoolFactory - the KeyedObjectPoolFactory to use to create KeyedObjectPool s for pooling java.sql.PreparedStatement s, or null to disable java.sql.PreparedStatement pooling
    validationQuery - a query to use to validate Connection s. Should return at least one row. Using null turns off validation.
    validationQueryTimeout - the number of seconds that validation queries will wait for database response before failing. Use a value less than or equal to 0 for no timeout.
    connectionInitSqls - a Collection of SQL statements to initialize Connection s. Using null turns off initialization.
    defaultReadOnly - the default "read only" setting for borrowed Connection s
    defaultAutoCommit - the default "auto commit" setting for returned Connection s
    defaultTransactionIsolation - the default "Transaction Isolation" setting for returned Connection s
    defaultCatalog - the default "catalog" setting for returned Connection s
    config - the AbandonedConfig if tracing SQL objects
    since: 1.3 -
Method from org.apache.commons.dbcp.PoolableConnectionFactory Summary:
activateObject,   destroyObject,   getPool,   initializeConnection,   makeObject,   passivateObject,   setConnectionFactory,   setConnectionInitSql,   setDefaultAutoCommit,   setDefaultCatalog,   setDefaultReadOnly,   setDefaultTransactionIsolation,   setPool,   setStatementPoolFactory,   setValidationQuery,   setValidationQueryTimeout,   validateConnection,   validateObject
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.dbcp.PoolableConnectionFactory Detail:
 public  void activateObject(Object obj) throws Exception 
 public  void destroyObject(Object obj) throws Exception 
 public synchronized ObjectPool getPool() 
 protected  void initializeConnection(Connection conn) throws SQLException 
 public Object makeObject() throws Exception 
 public  void passivateObject(Object obj) throws Exception 
 public  void setConnectionFactory(ConnectionFactory connFactory) 
 public synchronized  void setConnectionInitSql(Collection connectionInitSqls) 
    Sets the SQL statements I use to initialize newly created Connection s. Using null turns off connection initialization.
 public  void setDefaultAutoCommit(boolean defaultAutoCommit) 
    Sets the default "auto commit" setting for borrowed Connection s
 public  void setDefaultCatalog(String defaultCatalog) 
    Sets the default "catalog" setting for borrowed Connection s
 public  void setDefaultReadOnly(boolean defaultReadOnly) 
    Sets the default "read only" setting for borrowed Connection s
 public  void setDefaultTransactionIsolation(int defaultTransactionIsolation) 
    Sets the default "Transaction Isolation" setting for borrowed Connection s
 public synchronized  void setPool(ObjectPool pool) 
 public  void setStatementPoolFactory(KeyedObjectPoolFactory stmtPoolFactory) 
 public  void setValidationQuery(String validationQuery) 
    Sets the query I use to validate Connection s. Should return at least one row. Using null turns off validation.
 public  void setValidationQueryTimeout(int timeout) 
    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.
 public  void validateConnection(Connection conn) throws SQLException 
 public boolean validateObject(Object obj)