org.apache.commons.dbcp
Class AbandonedObjectPool

java.lang.Object
  extended by org.apache.commons.pool.BaseObjectPool
      extended by org.apache.commons.pool.impl.GenericObjectPool
          extended by org.apache.commons.dbcp.AbandonedObjectPool
All Implemented Interfaces:
ObjectPool

public class AbandonedObjectPool
extends GenericObjectPool

An implementation of a Jakarta-Commons ObjectPool which tracks JDBC connections and can recover abandoned db connections. If logAbandoned=true, a stack trace will be printed for any abandoned db connections recovered.

Version:
$Revision: 892307 $ $Date: 2014-01-01 00:27:28 +0100 (Wed, 01 Jan 2014) $
Author:
Glenn L. Nielsen

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.commons.pool.impl.GenericObjectPool
GenericObjectPool.Config
 
Field Summary
 
Fields inherited from class org.apache.commons.pool.impl.GenericObjectPool
DEFAULT_LIFO, DEFAULT_MAX_ACTIVE, DEFAULT_MAX_IDLE, DEFAULT_MAX_WAIT, DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS, DEFAULT_MIN_IDLE, DEFAULT_NUM_TESTS_PER_EVICTION_RUN, DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS, DEFAULT_TEST_ON_BORROW, DEFAULT_TEST_ON_RETURN, DEFAULT_TEST_WHILE_IDLE, DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS, DEFAULT_WHEN_EXHAUSTED_ACTION, WHEN_EXHAUSTED_BLOCK, WHEN_EXHAUSTED_FAIL, WHEN_EXHAUSTED_GROW
 
Constructor Summary
AbandonedObjectPool(PoolableObjectFactory factory, AbandonedConfig config)
          Create an ObjectPool which tracks db connections.
 
Method Summary
 Object borrowObject()
          Get a db connection from the pool.
 void invalidateObject(Object obj)
          Invalidates an object from the pool.
 void returnObject(Object obj)
          Return a db connection to the pool.
 
Methods inherited from class org.apache.commons.pool.impl.GenericObjectPool
addObject, clear, close, evict, getLifo, getMaxActive, getMaxIdle, getMaxWait, getMinEvictableIdleTimeMillis, getMinIdle, getNumActive, getNumIdle, getNumTestsPerEvictionRun, getSoftMinEvictableIdleTimeMillis, getTestOnBorrow, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, getWhenExhaustedAction, setConfig, setFactory, setLifo, setMaxActive, setMaxIdle, setMaxWait, setMinEvictableIdleTimeMillis, setMinIdle, setNumTestsPerEvictionRun, setSoftMinEvictableIdleTimeMillis, setTestOnBorrow, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setWhenExhaustedAction, startEvictor
 
Methods inherited from class org.apache.commons.pool.BaseObjectPool
assertOpen, isClosed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbandonedObjectPool

public AbandonedObjectPool(PoolableObjectFactory factory,
                           AbandonedConfig config)
Create an ObjectPool which tracks db connections.

Parameters:
factory - PoolableObjectFactory used to create this
config - configuration for abandoned db connections
Method Detail

borrowObject

public Object borrowObject()
                    throws Exception
Get a db connection from the pool. If removeAbandoned=true, recovers db connections which have been idle > removeAbandonedTimeout and getNumActive() > getMaxActive() - 3 and getNumIdle() < 2

Specified by:
borrowObject in interface ObjectPool
Overrides:
borrowObject in class GenericObjectPool
Returns:
Object jdbc Connection
Throws:
Exception - if an exception occurs retrieving a connection from the pool

returnObject

public void returnObject(Object obj)
                  throws Exception
Return a db connection to the pool.

Specified by:
returnObject in interface ObjectPool
Overrides:
returnObject in class GenericObjectPool
Parameters:
obj - db Connection to return
Throws:
Exception - if an exception occurs returning the connection to the pool

invalidateObject

public void invalidateObject(Object obj)
                      throws Exception
Invalidates an object from the pool.

Specified by:
invalidateObject in interface ObjectPool
Overrides:
invalidateObject in class GenericObjectPool
Parameters:
obj - object to be returned
Throws:
Exception - if an exception occurs invalidating the object


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.