|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.pool.BaseObjectPool
org.apache.commons.pool.impl.GenericObjectPool
public class GenericObjectPool
A configurable ObjectPool
implementation.
When coupled with the appropriate PoolableObjectFactory
,
GenericObjectPool provides robust pooling functionality for
arbitrary objects.
A GenericObjectPool provides a number of configurable parameters:
maxActive
controls the maximum number of objects that can
be borrowed from the pool at one time. When non-positive, there
is no limit to the number of objects that may be active at one time.
When maxActive
is exceeded, the pool is said to be exhausted.
maxIdle
controls the maximum number of objects that can
sit idle in the pool at any time. When negative, there
is no limit to the number of objects that may be idle at one time.
whenExhaustedAction
specifies the
behaviour of the borrowObject()
method when the pool is exhausted:
whenExhaustedAction
is
WHEN_EXHAUSTED_FAIL
, borrowObject()
will throw
a NoSuchElementException
whenExhaustedAction
is
WHEN_EXHAUSTED_GROW
, borrowObject()
will create a new
object and return it(essentially making maxActive
meaningless.)
whenExhaustedAction
is WHEN_EXHAUSTED_BLOCK
, borrowObject()
will block
(invoke Object.wait(long)
until a new or idle object is available.
If a positive maxWait
value is supplied, the borrowObject()
will block for at
most that many milliseconds, after which a NoSuchElementException
will be thrown. If maxWait
is non-positive,
the borrowObject()
method will block indefinitely.
testOnBorrow
is set, the pool will
attempt to validate each object before it is returned from the
borrowObject()
method. (Using the provided factory's
PoolableObjectFactory.validateObject(java.lang.Object)
method.) Objects that fail
to validate will be dropped from the pool, and a different object will
be borrowed.
testOnReturn
is set, the pool will
attempt to validate each object before it is returned to the pool in the
returnObject(java.lang.Object)
method. (Using the provided factory's
PoolableObjectFactory.validateObject(java.lang.Object)
method.) Objects that fail to validate will be dropped from the pool.
Optionally, one may configure the pool to examine and possibly evict objects as they sit idle in the pool. This is performed by an "idle object eviction" thread, which runs asychronously. The idle object eviction thread may be configured using the following attributes:
timeBetweenEvictionRunsMillis
indicates how long the eviction thread should sleep before "runs" of examining
idle objects. When non-positive, no eviction thread will be launched.
minEvictableIdleTimeMillis
specifies the minimum amount of time that an object may sit idle in the pool
before it is eligable for eviction due to idle time. When non-positive, no object
will be dropped from the pool due to idle time alone.
testWhileIdle
indicates whether or not idle
objects should be validated using the factory's
PoolableObjectFactory.validateObject(java.lang.Object)
method. Objects
that fail to validate will be dropped from the pool.
GenericObjectPool is not usable without a PoolableObjectFactory
. A
non-null
factory must be provided either as a constructor argument
or via a call to setFactory(org.apache.commons.pool.PoolableObjectFactory)
before the pool is used.
GenericKeyedObjectPool
Nested Class Summary | |
---|---|
static class |
GenericObjectPool.Config
A simple "struct" encapsulating the configuration information for a GenericObjectPool . |
Field Summary | |
---|---|
static int |
DEFAULT_MAX_ACTIVE
The default cap on the total number of active instances from the pool. |
static int |
DEFAULT_MAX_IDLE
The default cap on the number of "sleeping" instances in the pool. |
static long |
DEFAULT_MAX_WAIT
The default maximum amount of time (in millis) the borrowObject() method should block before throwing
an exception when the pool is exhausted and the
"when exhausted" action is
WHEN_EXHAUSTED_BLOCK . |
static long |
DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS
The default value for getMinEvictableIdleTimeMillis() . |
static int |
DEFAULT_MIN_IDLE
The default minimum number of "sleeping" instances in the pool before before the evictor thread (if active) spawns new objects. |
static int |
DEFAULT_NUM_TESTS_PER_EVICTION_RUN
The default number of objects to examine per run in the idle object evictor. |
static long |
DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS
The default value for getSoftMinEvictableIdleTimeMillis() . |
static boolean |
DEFAULT_TEST_ON_BORROW
The default "test on borrow" value. |
static boolean |
DEFAULT_TEST_ON_RETURN
The default "test on return" value. |
static boolean |
DEFAULT_TEST_WHILE_IDLE
The default "test while idle" value. |
static long |
DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS
The default "time between eviction runs" value. |
static byte |
DEFAULT_WHEN_EXHAUSTED_ACTION
The default "when exhausted action" for the pool. |
static byte |
WHEN_EXHAUSTED_BLOCK
A "when exhausted action" type indicating that when the pool is exhausted (i.e., the maximum number of active objects has been reached), the borrowObject()
method should block until a new object is available, or the
maximum wait time has been reached. |
static byte |
WHEN_EXHAUSTED_FAIL
A "when exhausted action" type indicating that when the pool is exhausted (i.e., the maximum number of active objects has been reached), the borrowObject()
method should fail, throwing a NoSuchElementException . |
static byte |
WHEN_EXHAUSTED_GROW
A "when exhausted action" type indicating that when the pool is exhausted (i.e., the maximum number of active objects has been reached), the borrowObject()
method should simply create a new object anyway. |
Constructor Summary | |
---|---|
GenericObjectPool()
Create a new GenericObjectPool. |
|
GenericObjectPool(PoolableObjectFactory factory)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
GenericObjectPool.Config config)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
int maxActive)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
int maxActive,
byte whenExhaustedAction,
long maxWait)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
boolean testOnBorrow,
boolean testOnReturn)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
boolean testOnBorrow,
boolean testOnReturn)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
int minIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle)
Create a new GenericObjectPool using the specified values. |
|
GenericObjectPool(PoolableObjectFactory factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
int minIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle,
long softMinEvictableIdleTimeMillis)
Create a new GenericObjectPool using the specified values. |
Method Summary | |
---|---|
void |
addObject()
Create an object, and place it into the pool. |
java.lang.Object |
borrowObject()
Obtain an instance from my pool. |
void |
clear()
Not supported in this base implementation. |
void |
close()
Close this pool, and free any resources associated with it. |
void |
evict()
|
int |
getMaxActive()
Returns the cap on the total number of active instances from my pool. |
int |
getMaxIdle()
Returns the cap on the number of "idle" instances in the pool. |
long |
getMaxWait()
Returns the maximum amount of time (in milliseconds) the borrowObject() method should block before throwing
an exception when the pool is exhausted and the
"when exhausted" action is
WHEN_EXHAUSTED_BLOCK . |
long |
getMinEvictableIdleTimeMillis()
Returns the minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any). |
int |
getMinIdle()
Returns the minimum number of objects allowed in the pool before the evictor thread (if active) spawns new objects. |
int |
getNumActive()
Not supported in this base implementation. |
int |
getNumIdle()
Not supported in this base implementation. |
int |
getNumTestsPerEvictionRun()
Returns the max number of objects to examine during each run of the idle object evictor thread (if any). |
long |
getSoftMinEvictableIdleTimeMillis()
Returns the minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any), with the extra condition that at least "minIdle" amount of object remain in the pool. |
boolean |
getTestOnBorrow()
When true, objects will be validated
before being returned by the borrowObject()
method. |
boolean |
getTestOnReturn()
When true, objects will be validated
before being returned to the pool within the
returnObject(java.lang.Object) . |
boolean |
getTestWhileIdle()
When true, objects will be validated
by the idle object evictor (if any). |
long |
getTimeBetweenEvictionRunsMillis()
Returns the number of milliseconds to sleep between runs of the idle object evictor thread. |
byte |
getWhenExhaustedAction()
Returns the action to take when the borrowObject() method
is invoked when the pool is exhausted (the maximum number
of "active" objects has been reached). |
void |
invalidateObject(java.lang.Object obj)
Invalidates an object from the pool By contract, obj MUST have been obtained using borrowObject
or a related method as defined in an implementation
or sub-interface. |
void |
returnObject(java.lang.Object obj)
Return an instance to my pool. |
void |
setConfig(GenericObjectPool.Config conf)
Sets my configuration. |
void |
setFactory(PoolableObjectFactory factory)
Not supported in this base implementation. |
void |
setMaxActive(int maxActive)
Sets the cap on the total number of active instances from my pool. |
void |
setMaxIdle(int maxIdle)
Sets the cap on the number of "idle" instances in the pool. |
void |
setMaxWait(long maxWait)
Sets the maximum amount of time (in milliseconds) the borrowObject() method should block before throwing
an exception when the pool is exhausted and the
"when exhausted" action is
WHEN_EXHAUSTED_BLOCK . |
void |
setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
Sets the minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any). |
void |
setMinIdle(int minIdle)
Sets the minimum number of objects allowed in the pool before the evictor thread (if active) spawns new objects. |
void |
setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
Sets the max number of objects to examine during each run of the idle object evictor thread (if any). |
void |
setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
Sets the minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any), with the extra condition that at least "minIdle" amount of object remain in the pool. |
void |
setTestOnBorrow(boolean testOnBorrow)
When true, objects will be validated
before being returned by the borrowObject()
method. |
void |
setTestOnReturn(boolean testOnReturn)
When true, objects will be validated
before being returned to the pool within the
returnObject(java.lang.Object) . |
void |
setTestWhileIdle(boolean testWhileIdle)
When true, objects will be validated
by the idle object evictor (if any). |
void |
setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
Sets the number of milliseconds to sleep between runs of the idle object evictor thread. |
void |
setWhenExhaustedAction(byte whenExhaustedAction)
Sets the action to take when the borrowObject() method
is invoked when the pool is exhausted (the maximum number
of "active" objects has been reached). |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_MAX_ACTIVE
getMaxActive()
,
Constant Field Valuespublic static final int DEFAULT_MAX_IDLE
getMaxIdle()
,
setMaxIdle(int)
,
Constant Field Valuespublic static final long DEFAULT_MAX_WAIT
borrowObject()
method should block before throwing
an exception when the pool is exhausted and the
"when exhausted" action
is
WHEN_EXHAUSTED_BLOCK
.
getMaxWait()
,
setMaxWait(long)
,
Constant Field Valuespublic static final long DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS
getMinEvictableIdleTimeMillis()
.
getMinEvictableIdleTimeMillis()
,
setMinEvictableIdleTimeMillis(long)
,
Constant Field Valuespublic static final int DEFAULT_MIN_IDLE
getMinIdle()
,
setMinIdle(int)
,
Constant Field Valuespublic static final int DEFAULT_NUM_TESTS_PER_EVICTION_RUN
getNumTestsPerEvictionRun()
,
setNumTestsPerEvictionRun(int)
,
getTimeBetweenEvictionRunsMillis()
,
setTimeBetweenEvictionRunsMillis(long)
,
Constant Field Valuespublic static final long DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS
getSoftMinEvictableIdleTimeMillis()
.
getSoftMinEvictableIdleTimeMillis()
,
setSoftMinEvictableIdleTimeMillis(long)
,
Constant Field Valuespublic static final boolean DEFAULT_TEST_ON_BORROW
getTestOnBorrow()
,
setTestOnBorrow(boolean)
,
Constant Field Valuespublic static final boolean DEFAULT_TEST_ON_RETURN
getTestOnReturn()
,
setTestOnReturn(boolean)
,
Constant Field Valuespublic static final boolean DEFAULT_TEST_WHILE_IDLE
getTestWhileIdle()
,
setTestWhileIdle(boolean)
,
getTimeBetweenEvictionRunsMillis()
,
setTimeBetweenEvictionRunsMillis(long)
,
Constant Field Valuespublic static final long DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS
getTimeBetweenEvictionRunsMillis()
,
setTimeBetweenEvictionRunsMillis(long)
,
Constant Field Valuespublic static final byte DEFAULT_WHEN_EXHAUSTED_ACTION
WHEN_EXHAUSTED_BLOCK
,
WHEN_EXHAUSTED_FAIL
,
WHEN_EXHAUSTED_GROW
,
setWhenExhaustedAction(byte)
,
Constant Field Valuespublic static final byte WHEN_EXHAUSTED_BLOCK
borrowObject()
method should block until a new object is available, or the
maximum wait time
has been reached.
WHEN_EXHAUSTED_FAIL
,
WHEN_EXHAUSTED_GROW
,
setMaxWait(long)
,
getMaxWait()
,
setWhenExhaustedAction(byte)
,
Constant Field Valuespublic static final byte WHEN_EXHAUSTED_FAIL
borrowObject()
method should fail, throwing a NoSuchElementException
.
WHEN_EXHAUSTED_BLOCK
,
WHEN_EXHAUSTED_GROW
,
setWhenExhaustedAction(byte)
,
Constant Field Valuespublic static final byte WHEN_EXHAUSTED_GROW
borrowObject()
method should simply create a new object anyway.
WHEN_EXHAUSTED_FAIL
,
WHEN_EXHAUSTED_GROW
,
setWhenExhaustedAction(byte)
,
Constant Field ValuesConstructor Detail |
---|
public GenericObjectPool()
public GenericObjectPool(PoolableObjectFactory factory)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectspublic GenericObjectPool(PoolableObjectFactory factory, GenericObjectPool.Config config)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsconfig
- a non-null GenericObjectPool.Config
describing my configurationpublic GenericObjectPool(PoolableObjectFactory factory, int maxActive)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsmaxActive
- the maximum number of objects that can be borrowed from me at one time (see setMaxActive(int)
)public GenericObjectPool(PoolableObjectFactory factory, int maxActive, byte whenExhaustedAction, long maxWait)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsmaxActive
- the maximum number of objects that can be borrowed from me at one time (see setMaxActive(int)
)whenExhaustedAction
- the action to take when the pool is exhausted (see getWhenExhaustedAction()
)maxWait
- the maximum amount of time to wait for an idle object when the pool is exhausted an and whenExhaustedAction is WHEN_EXHAUSTED_BLOCK
(otherwise ignored) (see getMaxWait()
)public GenericObjectPool(PoolableObjectFactory factory, int maxActive, byte whenExhaustedAction, long maxWait, boolean testOnBorrow, boolean testOnReturn)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsmaxActive
- the maximum number of objects that can be borrowed from me at one time (see setMaxActive(int)
)whenExhaustedAction
- the action to take when the pool is exhausted (see getWhenExhaustedAction()
)maxWait
- the maximum amount of time to wait for an idle object when the pool is exhausted an and whenExhaustedAction is WHEN_EXHAUSTED_BLOCK
(otherwise ignored) (see getMaxWait()
)testOnBorrow
- whether or not to validate objects before they are returned by the borrowObject()
method (see getTestOnBorrow()
)testOnReturn
- whether or not to validate objects after they are returned to the returnObject(java.lang.Object)
method (see getTestOnReturn()
)public GenericObjectPool(PoolableObjectFactory factory, int maxActive, byte whenExhaustedAction, long maxWait, int maxIdle)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsmaxActive
- the maximum number of objects that can be borrowed from me at one time (see setMaxActive(int)
)whenExhaustedAction
- the action to take when the pool is exhausted (see getWhenExhaustedAction()
)maxWait
- the maximum amount of time to wait for an idle object when the pool is exhausted an and whenExhaustedAction is WHEN_EXHAUSTED_BLOCK
(otherwise ignored) (see getMaxWait()
)maxIdle
- the maximum number of idle objects in my pool (see getMaxIdle()
)public GenericObjectPool(PoolableObjectFactory factory, int maxActive, byte whenExhaustedAction, long maxWait, int maxIdle, boolean testOnBorrow, boolean testOnReturn)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsmaxActive
- the maximum number of objects that can be borrowed from me at one time (see setMaxActive(int)
)whenExhaustedAction
- the action to take when the pool is exhausted (see getWhenExhaustedAction()
)maxWait
- the maximum amount of time to wait for an idle object when the pool is exhausted an and whenExhaustedAction is WHEN_EXHAUSTED_BLOCK
(otherwise ignored) (see getMaxWait()
)maxIdle
- the maximum number of idle objects in my pool (see getMaxIdle()
)testOnBorrow
- whether or not to validate objects before they are returned by the borrowObject()
method (see getTestOnBorrow()
)testOnReturn
- whether or not to validate objects after they are returned to the returnObject(java.lang.Object)
method (see getTestOnReturn()
)public GenericObjectPool(PoolableObjectFactory factory, int maxActive, byte whenExhaustedAction, long maxWait, int maxIdle, boolean testOnBorrow, boolean testOnReturn, long timeBetweenEvictionRunsMillis, int numTestsPerEvictionRun, long minEvictableIdleTimeMillis, boolean testWhileIdle)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsmaxActive
- the maximum number of objects that can be borrowed from me at one time (see setMaxActive(int)
)whenExhaustedAction
- the action to take when the pool is exhausted (see setWhenExhaustedAction(byte)
)maxWait
- the maximum amount of time to wait for an idle object when the pool is exhausted an and whenExhaustedAction is WHEN_EXHAUSTED_BLOCK
(otherwise ignored) (see setMaxWait(long)
)maxIdle
- the maximum number of idle objects in my pool (see setMaxIdle(int)
)testOnBorrow
- whether or not to validate objects before they are returned by the borrowObject()
method (see setTestOnBorrow(boolean)
)testOnReturn
- whether or not to validate objects after they are returned to the returnObject(java.lang.Object)
method (see setTestOnReturn(boolean)
)timeBetweenEvictionRunsMillis
- the amount of time (in milliseconds) to sleep between examining idle objects for eviction (see setTimeBetweenEvictionRunsMillis(long)
)numTestsPerEvictionRun
- the number of idle objects to examine per run within the idle object eviction thread (if any) (see setNumTestsPerEvictionRun(int)
)minEvictableIdleTimeMillis
- the minimum number of milliseconds an object can sit idle in the pool before it is eligable for evcition (see setMinEvictableIdleTimeMillis(long)
)testWhileIdle
- whether or not to validate objects in the idle object eviction thread, if any (see setTestWhileIdle(boolean)
)public GenericObjectPool(PoolableObjectFactory factory, int maxActive, byte whenExhaustedAction, long maxWait, int maxIdle, int minIdle, boolean testOnBorrow, boolean testOnReturn, long timeBetweenEvictionRunsMillis, int numTestsPerEvictionRun, long minEvictableIdleTimeMillis, boolean testWhileIdle)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsmaxActive
- the maximum number of objects that can be borrowed from me at one time (see setMaxActive(int)
)whenExhaustedAction
- the action to take when the pool is exhausted (see setWhenExhaustedAction(byte)
)maxWait
- the maximum amount of time to wait for an idle object when the pool is exhausted an and whenExhaustedAction is WHEN_EXHAUSTED_BLOCK
(otherwise ignored) (see setMaxWait(long)
)maxIdle
- the maximum number of idle objects in my pool (see setMaxIdle(int)
)minIdle
- the minimum number of idle objects in my pool (see setMinIdle(int)
)testOnBorrow
- whether or not to validate objects before they are returned by the borrowObject()
method (see setTestOnBorrow(boolean)
)testOnReturn
- whether or not to validate objects after they are returned to the returnObject(java.lang.Object)
method (see setTestOnReturn(boolean)
)timeBetweenEvictionRunsMillis
- the amount of time (in milliseconds) to sleep between examining idle objects for eviction (see setTimeBetweenEvictionRunsMillis(long)
)numTestsPerEvictionRun
- the number of idle objects to examine per run within the idle object eviction thread (if any) (see setNumTestsPerEvictionRun(int)
)minEvictableIdleTimeMillis
- the minimum number of milliseconds an object can sit idle in the pool before it is eligable for evcition (see setMinEvictableIdleTimeMillis(long)
)testWhileIdle
- whether or not to validate objects in the idle object eviction thread, if any (see setTestWhileIdle(boolean)
)public GenericObjectPool(PoolableObjectFactory factory, int maxActive, byte whenExhaustedAction, long maxWait, int maxIdle, int minIdle, boolean testOnBorrow, boolean testOnReturn, long timeBetweenEvictionRunsMillis, int numTestsPerEvictionRun, long minEvictableIdleTimeMillis, boolean testWhileIdle, long softMinEvictableIdleTimeMillis)
factory
- the (possibly null)PoolableObjectFactory to use to create, validate and destroy objectsmaxActive
- the maximum number of objects that can be borrowed from me at one time (see setMaxActive(int)
)whenExhaustedAction
- the action to take when the pool is exhausted (see setWhenExhaustedAction(byte)
)maxWait
- the maximum amount of time to wait for an idle object when the pool is exhausted an and whenExhaustedAction is WHEN_EXHAUSTED_BLOCK
(otherwise ignored) (see setMaxWait(long)
)maxIdle
- the maximum number of idle objects in my pool (see setMaxIdle(int)
)minIdle
- the minimum number of idle objects in my pool (see setMinIdle(int)
)testOnBorrow
- whether or not to validate objects before they are returned by the borrowObject()
method (see setTestOnBorrow(boolean)
)testOnReturn
- whether or not to validate objects after they are returned to the returnObject(java.lang.Object)
method (see setTestOnReturn(boolean)
)timeBetweenEvictionRunsMillis
- the amount of time (in milliseconds) to sleep between examining idle objects for eviction (see setTimeBetweenEvictionRunsMillis(long)
)numTestsPerEvictionRun
- the number of idle objects to examine per run within the idle object eviction thread (if any) (see setNumTestsPerEvictionRun(int)
)minEvictableIdleTimeMillis
- the minimum number of milliseconds an object can sit idle in the pool before it is eligable for evcition (see setMinEvictableIdleTimeMillis(long)
)testWhileIdle
- whether or not to validate objects in the idle object eviction thread, if any (see setTestWhileIdle(boolean)
)softMinEvictableIdleTimeMillis
- the minimum number of milliseconds an object can sit idle in the pool before it is eligable for evcition with the extra condition that at least "minIdle" amount of object remain in the pool. (see setSoftMinEvictableIdleTimeMillis(long)
)Method Detail |
---|
public void addObject() throws java.lang.Exception
addObject
in interface ObjectPool
addObject
in class BaseObjectPool
java.lang.Exception
public java.lang.Object borrowObject() throws java.lang.Exception
ObjectPool
returnObject
or a related method as defined in an implementation
or sub-interface.
The behaviour of this method when the pool has been exhausted is not specified (although it may be specified by implementations).
borrowObject
in interface ObjectPool
borrowObject
in class BaseObjectPool
java.lang.Exception
public void clear()
BaseObjectPool
clear
in interface ObjectPool
clear
in class BaseObjectPool
public void close() throws java.lang.Exception
ObjectPool
close
in interface ObjectPool
close
in class BaseObjectPool
java.lang.Exception
public void evict() throws java.lang.Exception
java.lang.Exception
public int getMaxActive()
setMaxActive(int)
public int getMaxIdle()
setMaxIdle(int)
public long getMaxWait()
borrowObject()
method should block before throwing
an exception when the pool is exhausted and the
"when exhausted" action
is
WHEN_EXHAUSTED_BLOCK
.
When less than 0, the borrowObject()
method
may block indefinitely.
setMaxWait(long)
,
setWhenExhaustedAction(byte)
,
WHEN_EXHAUSTED_BLOCK
public long getMinEvictableIdleTimeMillis()
setMinEvictableIdleTimeMillis(long)
,
setTimeBetweenEvictionRunsMillis(long)
public int getMinIdle()
setMinIdle(int)
public int getNumActive()
BaseObjectPool
getNumActive
in interface ObjectPool
getNumActive
in class BaseObjectPool
public int getNumIdle()
BaseObjectPool
getNumIdle
in interface ObjectPool
getNumIdle
in class BaseObjectPool
public int getNumTestsPerEvictionRun()
setNumTestsPerEvictionRun(int)
,
setTimeBetweenEvictionRunsMillis(long)
public long getSoftMinEvictableIdleTimeMillis()
setSoftMinEvictableIdleTimeMillis(long)
public boolean getTestOnBorrow()
validated
before being returned by the borrowObject()
method. If the object fails to validate,
it will be dropped from the pool, and we will attempt
to borrow another.
setTestOnBorrow(boolean)
public boolean getTestOnReturn()
validated
before being returned to the pool within the
returnObject(java.lang.Object)
.
setTestOnReturn(boolean)
public boolean getTestWhileIdle()
validated
by the idle object evictor (if any). If an object
fails to validate, it will be dropped from the pool.
setTestWhileIdle(boolean)
,
setTimeBetweenEvictionRunsMillis(long)
public long getTimeBetweenEvictionRunsMillis()
setTimeBetweenEvictionRunsMillis(long)
public byte getWhenExhaustedAction()
borrowObject()
method
is invoked when the pool is exhausted (the maximum number
of "active" objects has been reached).
WHEN_EXHAUSTED_BLOCK
, WHEN_EXHAUSTED_FAIL
or WHEN_EXHAUSTED_GROW
setWhenExhaustedAction(byte)
public void invalidateObject(java.lang.Object obj) throws java.lang.Exception
ObjectPool
borrowObject
or a related method as defined in an implementation
or sub-interface.
This method should be used when an object that has been borrowed
is determined (due to an exception or other problem) to be invalid.
If the connection should be validated before or after borrowing,
then the PoolableObjectFactory.validateObject(java.lang.Object)
method should be
used instead.
invalidateObject
in interface ObjectPool
invalidateObject
in class BaseObjectPool
obj
- a borrowed
instance to be returned.
java.lang.Exception
public void returnObject(java.lang.Object obj) throws java.lang.Exception
ObjectPool
borrowObject
or a related method as defined in an implementation
or sub-interface.
returnObject
in interface ObjectPool
returnObject
in class BaseObjectPool
obj
- a borrowed
instance to be returned.
java.lang.Exception
public void setConfig(GenericObjectPool.Config conf)
GenericObjectPool.Config
public void setFactory(PoolableObjectFactory factory) throws java.lang.IllegalStateException
BaseObjectPool
setFactory
in interface ObjectPool
setFactory
in class BaseObjectPool
factory
- the PoolableObjectFactory
I use to create new instances.
java.lang.IllegalStateException
- when the factory cannot be set at this timepublic void setMaxActive(int maxActive)
maxActive
- The cap on the total number of active instances from my pool.
Use a negative value for an infinite number of instances.getMaxActive()
public void setMaxIdle(int maxIdle)
maxIdle
- The cap on the number of "idle" instances in the pool.
Use a negative value to indicate an unlimited number
of idle instances.getMaxIdle()
public void setMaxWait(long maxWait)
borrowObject()
method should block before throwing
an exception when the pool is exhausted and the
"when exhausted" action
is
WHEN_EXHAUSTED_BLOCK
.
When less than 0, the borrowObject()
method
may block indefinitely.
getMaxWait()
,
setWhenExhaustedAction(byte)
,
WHEN_EXHAUSTED_BLOCK
public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
getMinEvictableIdleTimeMillis()
,
setTimeBetweenEvictionRunsMillis(long)
public void setMinIdle(int minIdle)
minIdle
- The minimum number of objects.getMinIdle()
public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
When a negative value is supplied, ceil(getNumIdle()
)/abs(getNumTestsPerEvictionRun()
)
tests will be run. I.e., when the value is -n, roughly one nth of the
idle objects will be tested per run.
getNumTestsPerEvictionRun()
,
setTimeBetweenEvictionRunsMillis(long)
public void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
getSoftMinEvictableIdleTimeMillis()
public void setTestOnBorrow(boolean testOnBorrow)
validated
before being returned by the borrowObject()
method. If the object fails to validate,
it will be dropped from the pool, and we will attempt
to borrow another.
getTestOnBorrow()
public void setTestOnReturn(boolean testOnReturn)
validated
before being returned to the pool within the
returnObject(java.lang.Object)
.
getTestOnReturn()
public void setTestWhileIdle(boolean testWhileIdle)
validated
by the idle object evictor (if any). If an object
fails to validate, it will be dropped from the pool.
getTestWhileIdle()
,
setTimeBetweenEvictionRunsMillis(long)
public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
getTimeBetweenEvictionRunsMillis()
public void setWhenExhaustedAction(byte whenExhaustedAction)
borrowObject()
method
is invoked when the pool is exhausted (the maximum number
of "active" objects has been reached).
whenExhaustedAction
- the action code, which must be one of
WHEN_EXHAUSTED_BLOCK
, WHEN_EXHAUSTED_FAIL
,
or WHEN_EXHAUSTED_GROW
getWhenExhaustedAction()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |