|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.pool2.impl.AbandonedConfig
public class AbandonedConfig
Configuration settings for abandoned object removal.
Constructor Summary | |
---|---|
AbandonedConfig()
|
Method Summary | |
---|---|
boolean |
getLogAbandoned()
Flag to log stack traces for application code which abandoned an object. |
PrintWriter |
getLogWriter()
Returns the log writer being used by this configuration to log information on abandoned objects. |
boolean |
getRemoveAbandonedOnBorrow()
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when borrowObject is invoked. |
boolean |
getRemoveAbandonedOnMaintenance()
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when pool maintenance (the "evictor") runs. |
int |
getRemoveAbandonedTimeout()
Timeout in seconds before an abandoned object can be removed. |
boolean |
getUseUsageTracking()
If the pool implements UsageTracking , should the pool record a
stack trace every time a method is called on a pooled object and retain
the most recent stack trace to aid debugging of abandoned objects? |
void |
setLogAbandoned(boolean logAbandoned)
Sets the flag to log stack traces for application code which abandoned an object. |
void |
setLogWriter(PrintWriter logWriter)
Sets the log writer to be used by this configuration to log information on abandoned objects. |
void |
setRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow)
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when borrowObject is invoked. |
void |
setRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance)
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when pool maintenance runs. |
void |
setRemoveAbandonedTimeout(int removeAbandonedTimeout)
Sets the timeout in seconds before an abandoned object can be removed |
void |
setUseUsageTracking(boolean useUsageTracking)
If the pool implements UsageTracking , configure whether the pool
should record a stack trace every time a method is called on a pooled
object and retain the most recent stack trace to aid debugging of
abandoned objects. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbandonedConfig()
Method Detail |
---|
public boolean getRemoveAbandonedOnBorrow()
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when borrowObject is invoked.
The default value is false.
If set to true, abandoned objects are removed by borrowObject if
there are fewer than 2 idle objects available in the pool and
getNumActive() > getMaxTotal() - 3
public void setRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow)
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when borrowObject is invoked.
removeAbandonedOnBorrow
- true means abandoned objects will be
removed by borrowObjectgetRemoveAbandonedOnBorrow()
public boolean getRemoveAbandonedOnMaintenance()
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when pool maintenance (the "evictor") runs.
The default value is false.
If set to true, abandoned objects are removed by the pool
maintenance thread when it runs. This setting has no effect
unless maintenance is enabled by setting
timeBetweenEvictionRunsMillis
to a positive number.
public void setRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance)
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when pool maintenance runs.
removeAbandonedOnMaintenance
- true means abandoned objects will be
removed by pool maintenancegetRemoveAbandonedOnMaintenance()
public int getRemoveAbandonedTimeout()
Timeout in seconds before an abandoned object can be removed.
The time of most recent use of an object is the maximum (latest) of
TrackedUse.getLastUsed()
(if this class of the object implements
TrackedUse) and the time when the object was borrowed from the pool.
The default value is 300 seconds.
public void setRemoveAbandonedTimeout(int removeAbandonedTimeout)
Sets the timeout in seconds before an abandoned object can be removed
Setting this property has no effect if
removeAbandonedOnBorrow
and
removeAbandonedOnMaintenance
are both false.
removeAbandonedTimeout
- new abandoned timeout in secondsgetRemoveAbandonedTimeout()
public boolean getLogAbandoned()
public void setLogAbandoned(boolean logAbandoned)
logAbandoned
- true turns on abandoned stack trace logginggetLogAbandoned()
public PrintWriter getLogWriter()
public void setLogWriter(PrintWriter logWriter)
logWriter
- The new log writerpublic boolean getUseUsageTracking()
UsageTracking
, should the pool record a
stack trace every time a method is called on a pooled object and retain
the most recent stack trace to aid debugging of abandoned objects?
true
if usage tracking is enabledpublic void setUseUsageTracking(boolean useUsageTracking)
UsageTracking
, configure whether the pool
should record a stack trace every time a method is called on a pooled
object and retain the most recent stack trace to aid debugging of
abandoned objects.
useUsageTracking
- A value of true
will enable
the recording of a stack trace on every use
of a pooled object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |