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

All Implemented Interfaces:
    KeyedObjectPoolFactory

A factory for creating GenericKeyedObjectPool instances.
Field Summary
protected  int _maxIdle     
protected  int _maxActive     
protected  int _maxTotal     
protected  int _minIdle     
protected  long _maxWait     
protected  byte _whenExhaustedAction     
protected  boolean _testOnBorrow     
protected  boolean _testOnReturn     
protected  boolean _testWhileIdle     
protected  long _timeBetweenEvictionRunsMillis     
protected  int _numTestsPerEvictionRun     
protected  long _minEvictableIdleTimeMillis     
protected  KeyedPoolableObjectFactory _factory     
protected  boolean _lifo     
Constructor:
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    GenericKeyedObjectPool.Config config) throws NullPointerException 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    config - a non-null GenericKeyedObjectPool.Config describing the configuration.
    Throws:
    NullPointerException - when config is null.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, GenericKeyedObjectPool.Config)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait,
    int maxIdle) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    maxIdle - the maximum number of idle objects in the pools.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait,
    boolean testOnBorrow,
    boolean testOnReturn) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    testOnBorrow - whether to validate objects before they are returned by borrowObject.
    testOnReturn - whether to validate objects after they are returned to returnObject.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, boolean, boolean)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait,
    int maxIdle,
    int maxTotal) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    maxIdle - the maximum number of idle objects in the pools.
    maxTotal - the maximum number of objects that can exists at one time.
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait,
    int maxIdle,
    boolean testOnBorrow,
    boolean testOnReturn) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    maxIdle - the maximum number of idle objects in the pools.
    testOnBorrow - whether to validate objects before they are returned by borrowObject.
    testOnReturn - whether to validate objects after they are returned to returnObject.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, boolean, boolean)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait,
    int maxIdle,
    boolean testOnBorrow,
    boolean testOnReturn,
    long timeBetweenEvictionRunsMillis,
    int numTestsPerEvictionRun,
    long minEvictableIdleTimeMillis,
    boolean testWhileIdle) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    maxIdle - the maximum number of idle objects in the pools.
    testOnBorrow - whether to validate objects before they are returned by borrowObject.
    testOnReturn - whether to validate objects after they are returned to returnObject.
    timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between examining idle objects for eviction.
    numTestsPerEvictionRun - the number of idle objects to examine per run of the evictor.
    minEvictableIdleTimeMillis - the minimum number of milliseconds an object can sit idle in the pool before it is eligible for eviction.
    testWhileIdle - whether to validate objects in the idle object eviction thread.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, boolean, boolean, long, int, long, boolean)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait,
    int maxIdle,
    int maxTotal,
    boolean testOnBorrow,
    boolean testOnReturn,
    long timeBetweenEvictionRunsMillis,
    int numTestsPerEvictionRun,
    long minEvictableIdleTimeMillis,
    boolean testWhileIdle) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    maxIdle - the maximum number of idle objects in the pools.
    maxTotal - the maximum number of objects that can exists at one time.
    testOnBorrow - whether to validate objects before they are returned by borrowObject.
    testOnReturn - whether to validate objects after they are returned to returnObject.
    timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between examining idle objects for eviction.
    numTestsPerEvictionRun - the number of idle objects to examine per run of the evictor.
    minEvictableIdleTimeMillis - the minimum number of milliseconds an object can sit idle in the pool before it is eligible for eviction.
    testWhileIdle - whether to validate objects in the idle object eviction thread.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, int, boolean, boolean, long, int, long, boolean)
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait,
    int maxIdle,
    int maxTotal,
    int minIdle,
    boolean testOnBorrow,
    boolean testOnReturn,
    long timeBetweenEvictionRunsMillis,
    int numTestsPerEvictionRun,
    long minEvictableIdleTimeMillis,
    boolean testWhileIdle) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    maxIdle - the maximum number of idle objects in the pools.
    maxTotal - the maximum number of objects that can exists at one time.
    minIdle - the minimum number of idle objects to have in the pool at any one time.
    testOnBorrow - whether to validate objects before they are returned by borrowObject.
    testOnReturn - whether to validate objects after they are returned to returnObject.
    timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between examining idle objects for eviction.
    numTestsPerEvictionRun - the number of idle objects to examine per run of the evictor.
    minEvictableIdleTimeMillis - the minimum number of milliseconds an object can sit idle in the pool before it is eligible for eviction.
    testWhileIdle - whether to validate objects in the idle object eviction thread.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, int, int, boolean, boolean, long, int, long, boolean)
    since: Pool - 1.3
 public GenericKeyedObjectPoolFactory(KeyedPoolableObjectFactory factory,
    int maxActive,
    byte whenExhaustedAction,
    long maxWait,
    int maxIdle,
    int maxTotal,
    int minIdle,
    boolean testOnBorrow,
    boolean testOnReturn,
    long timeBetweenEvictionRunsMillis,
    int numTestsPerEvictionRun,
    long minEvictableIdleTimeMillis,
    boolean testWhileIdle,
    boolean lifo) 
    Create a new GenericKeyedObjectPoolFactory.
    Parameters:
    factory - the KeyedPoolableObjectFactory to used by created pools.
    maxActive - the maximum number of objects that can be borrowed from pools at one time.
    whenExhaustedAction - the action to take when the pool is exhausted.
    maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
    maxIdle - the maximum number of idle objects in the pools.
    maxTotal - the maximum number of objects that can exists at one time.
    minIdle - the minimum number of idle objects to have in the pool at any one time.
    testOnBorrow - whether to validate objects before they are returned by borrowObject.
    testOnReturn - whether to validate objects after they are returned to returnObject.
    timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between examining idle objects for eviction.
    numTestsPerEvictionRun - the number of idle objects to examine per run of the evictor.
    minEvictableIdleTimeMillis - the minimum number of milliseconds an object can sit idle in the pool before it is eligible for eviction.
    testWhileIdle - whether to validate objects in the idle object eviction thread.
    lifo - whether or not objects are returned in last-in-first-out order from the idle object pool.
    Also see:
    GenericKeyedObjectPool#GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, int, int, boolean, boolean, long, int, long, boolean, boolean)
    since: Pool - 1.4
Method from org.apache.commons.pool.impl.GenericKeyedObjectPoolFactory Summary:
createPool
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.pool.impl.GenericKeyedObjectPoolFactory Detail:
 public KeyedObjectPool createPool()