Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> commons >> [ dbcp overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.commons.dbcp.PoolableConnectionFactory JAVADOC | Sourc code of org.apache.commons.dbcp.PoolableConnectionFactory SOURCE | Download org.apache.commons.dbcp.PoolableConnectionFactory DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.dbcp
Class PoolableConnectionFactory  view PoolableConnectionFactory download PoolableConnectionFactory.java

java.lang.Object
  extended byorg.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 org.apache.commons.pool.PoolableObjectFactory that creates PoolableConnections.

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

Field Summary
protected  AbandonedConfig _config
          Deprecated. AbandonedConfig is now deprecated.
protected  ConnectionFactory _connFactory
           
protected  boolean _defaultAutoCommit
           
protected  java.lang.String _defaultCatalog
           
protected  java.lang.Boolean _defaultReadOnly
           
protected  int _defaultTransactionIsolation
           
protected  org.apache.commons.pool.ObjectPool _pool
           
protected  org.apache.commons.pool.KeyedObjectPoolFactory _stmtPoolFactory
           
protected  java.lang.String _validationQuery
           
(package private) static int UNKNOWN_TRANSACTIONISOLATION
          Internal constant to indicate the level is not set.
 
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, AbandonedConfig config)
          Deprecated. AbandonedConfig is now deprecated.
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, boolean defaultReadOnly, boolean defaultAutoCommit, int defaultTransactionIsolation, AbandonedConfig config)
          Deprecated. AbandonedConfig is now deprecated.
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, java.lang.String defaultCatalog, AbandonedConfig config)
          Deprecated. AbandonedConfig is now deprecated.
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, AbandonedConfig config)
          Create a new PoolableConnectionFactory.
 
Method Summary
 void activateObject(java.lang.Object obj)
          Reinitialize an instance to be returned by the pool.
 void destroyObject(java.lang.Object obj)
          Destroys an instance no longer needed by the pool.
 org.apache.commons.pool.ObjectPool getPool()
           
 java.lang.Object makeObject()
          Creates an instance that can be returned by the pool.
 void passivateObject(java.lang.Object obj)
          Uninitialize an instance to be returned to the pool.
 void setConnectionFactory(ConnectionFactory connFactory)
          Sets the ConnectionFactory from which to obtain base java.sql.Connections.
 void setDefaultAutoCommit(boolean defaultAutoCommit)
          Sets the default "auto commit" setting for borrowed java.sql.Connections
 void setDefaultCatalog(java.lang.String defaultCatalog)
          Sets the default "catalog" setting for borrowed java.sql.Connections
 void setDefaultReadOnly(boolean defaultReadOnly)
          Sets the default "read only" setting for borrowed java.sql.Connections
 void setDefaultTransactionIsolation(int defaultTransactionIsolation)
          Sets the default "Transaction Isolation" setting for borrowed java.sql.Connections
 void setPool(org.apache.commons.pool.ObjectPool pool)
          Sets the org.apache.commons.pool.ObjectPool in which to pool java.sql.Connections.
 void setStatementPoolFactory(org.apache.commons.pool.KeyedObjectPoolFactory stmtPoolFactory)
          Sets the org.apache.commons.pool.KeyedObjectPoolFactory I use to create org.apache.commons.pool.KeyedObjectPools for pooling java.sql.PreparedStatements.
 void setValidationQuery(java.lang.String validationQuery)
          Sets the query I use to validate 55 java.sql.Connections.
 void validateConnection(java.sql.Connection conn)
           
 boolean validateObject(java.lang.Object obj)
          Ensures that the instance is safe to be returned by the pool.
 
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 java.lang.String _validationQuery

_pool

protected org.apache.commons.pool.ObjectPool _pool

_stmtPoolFactory

protected org.apache.commons.pool.KeyedObjectPoolFactory _stmtPoolFactory

_defaultReadOnly

protected java.lang.Boolean _defaultReadOnly

_defaultAutoCommit

protected boolean _defaultAutoCommit

_defaultTransactionIsolation

protected int _defaultTransactionIsolation

_defaultCatalog

protected java.lang.String _defaultCatalog

_config

protected AbandonedConfig _config
Deprecated. AbandonedConfig is now deprecated.

UNKNOWN_TRANSACTIONISOLATION

static final int UNKNOWN_TRANSACTIONISOLATION
Internal constant to indicate the level is not set.

See Also:
Constant Field Values
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.

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.

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,
                                 AbandonedConfig config)
Deprecated. AbandonedConfig is now deprecated.

Create a new PoolableConnectionFactory.

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,
                                 AbandonedConfig config)
Deprecated. AbandonedConfig is now deprecated.

Create a new PoolableConnectionFactory.

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,
                                 java.lang.String defaultCatalog,
                                 AbandonedConfig config)
Deprecated. AbandonedConfig is now deprecated.

Create a new PoolableConnectionFactory.

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,
                                 AbandonedConfig config)
Create a new PoolableConnectionFactory.

Method Detail

setConnectionFactory

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

setValidationQuery

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

setPool

public void setPool(org.apache.commons.pool.ObjectPool pool)
Sets the org.apache.commons.pool.ObjectPool in which to pool java.sql.Connections.

getPool

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

setStatementPoolFactory

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

setDefaultReadOnly

public void setDefaultReadOnly(boolean defaultReadOnly)
Sets the default "read only" setting for borrowed java.sql.Connections

setDefaultAutoCommit

public void setDefaultAutoCommit(boolean defaultAutoCommit)
Sets the default "auto commit" setting for borrowed java.sql.Connections

setDefaultTransactionIsolation

public void setDefaultTransactionIsolation(int defaultTransactionIsolation)
Sets the default "Transaction Isolation" setting for borrowed java.sql.Connections

setDefaultCatalog

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

makeObject

public java.lang.Object makeObject()
                            throws java.lang.Exception
Description copied from interface: org.apache.commons.pool.PoolableObjectFactory
Creates an instance that can be returned by the pool.

Specified by:
makeObject in interface org.apache.commons.pool.PoolableObjectFactory

destroyObject

public void destroyObject(java.lang.Object obj)
                   throws java.lang.Exception
Description copied from interface: org.apache.commons.pool.PoolableObjectFactory
Destroys an instance no longer needed by the pool.

Specified by:
destroyObject in interface org.apache.commons.pool.PoolableObjectFactory

validateObject

public boolean validateObject(java.lang.Object obj)
Description copied from interface: org.apache.commons.pool.PoolableObjectFactory
Ensures that the instance is safe to be returned by the pool. Returns false if this object should be destroyed.

Specified by:
validateObject in interface org.apache.commons.pool.PoolableObjectFactory

validateConnection

public void validateConnection(java.sql.Connection conn)
                        throws java.sql.SQLException

passivateObject

public void passivateObject(java.lang.Object obj)
                     throws java.lang.Exception
Description copied from interface: org.apache.commons.pool.PoolableObjectFactory
Uninitialize an instance to be returned to the pool.

Specified by:
passivateObject in interface org.apache.commons.pool.PoolableObjectFactory

activateObject

public void activateObject(java.lang.Object obj)
                    throws java.lang.Exception
Description copied from interface: org.apache.commons.pool.PoolableObjectFactory
Reinitialize an instance to be returned by the pool.

Specified by:
activateObject in interface org.apache.commons.pool.PoolableObjectFactory
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> commons >> [ dbcp overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.commons.dbcp.PoolableConnectionFactory JAVADOC | Sourc code of org.apache.commons.dbcp.PoolableConnectionFactory SOURCE | Download org.apache.commons.dbcp.PoolableConnectionFactory DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD