Class AbandonedConfig
- Since:
- 2.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic AbandonedConfigcopy(AbandonedConfig abandonedConfig) Creates a new instance with values from the given instance.booleanFlag to log stack traces for application code which abandoned an object.Gets the log writer being used by this configuration to log information on abandoned objects.booleanFlag to remove abandoned objects if they exceed the removeAbandonedTimeout when borrowObject is invoked.booleanFlag to remove abandoned objects if they exceed the removeAbandonedTimeout when pool maintenance (the "evictor") runs.intDeprecated.Timeout before an abandoned object can be removed.booleanIndicates if full stack traces are required whenlogAbandonedis true.booleanIf the pool implementsUsageTracking, 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?voidsetLogAbandoned(boolean logAbandoned) Sets the flag to log stack traces for application code which abandoned an object.voidsetLogWriter(PrintWriter logWriter) Sets the log writer to be used by this configuration to log information on abandoned objects.voidsetRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow) Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when borrowObject is invoked.voidsetRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance) Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when pool maintenance runs.voidsetRemoveAbandonedTimeout(int removeAbandonedTimeoutSeconds) Deprecated.voidsetRemoveAbandonedTimeout(Duration removeAbandonedTimeout) Sets the timeout before an abandoned object can be removed.voidsetRequireFullStackTrace(boolean requireFullStackTrace) Sets the flag to require full stack traces for logging abandoned connections when enabled.voidsetUseUsageTracking(boolean useUsageTracking) If the pool implementsUsageTracking, 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.toString()
-
Constructor Details
-
AbandonedConfig
public AbandonedConfig()Creates a new instance.
-
-
Method Details
-
copy
Creates a new instance with values from the given instance.- Parameters:
abandonedConfig- the source, may be null.- Returns:
- A new instance or null if the input is null.
- Since:
- 2.11.0
-
getLogAbandoned
Flag to log stack traces for application code which abandoned an object. Defaults to false. Logging of abandoned objects adds overhead for every object created because a stack trace has to be generated.- Returns:
- boolean true if stack trace logging is turned on for abandoned objects
-
getLogWriter
Gets the log writer being used by this configuration to log information on abandoned objects. If not set, a PrintWriter based on System.out with the system default encoding is used.- Returns:
- log writer in use
-
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- Returns:
- true if abandoned objects are to be removed by borrowObject
-
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
BaseGenericObjectPool.getDurationBetweenEvictionRuns()to a positive number.- Returns:
- true if abandoned objects are to be removed by the evictor
-
getRemoveAbandonedTimeout
Deprecated.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.getLastUsedInstant()(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.
- Returns:
- the abandoned object timeout in seconds.
-
getRemoveAbandonedTimeoutDuration
Timeout before an abandoned object can be removed.
The time of most recent use of an object is the maximum (latest) of
TrackedUse.getLastUsedInstant()(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.
- Returns:
- the abandoned object timeout.
- Since:
- 2.10.0
-
getRequireFullStackTrace
Indicates if full stack traces are required whenlogAbandonedis true. Defaults to true. Logging of abandoned objects requiring a full stack trace will generate an entire stack trace to generate for every object created. If this is disabled, a faster but less informative stack walking mechanism may be used if available.- Returns:
- true if full stack traces are required for logging abandoned connections, or false if abbreviated stack traces are acceptable
- Since:
- 2.5
- See Also:
-
getUseUsageTracking
If the pool implementsUsageTracking, 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?- Returns:
trueif usage tracking is enabled
-
setLogAbandoned
Sets the flag to log stack traces for application code which abandoned an object.- Parameters:
logAbandoned- true turns on abandoned stack trace logging- See Also:
-
setLogWriter
Sets the log writer to be used by this configuration to log information on abandoned objects.- Parameters:
logWriter- The new log writer
-
setRemoveAbandonedOnBorrow
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when borrowObject is invoked.- Parameters:
removeAbandonedOnBorrow- true means abandoned objects will be removed by borrowObject- See Also:
-
setRemoveAbandonedOnMaintenance
Flag to remove abandoned objects if they exceed the removeAbandonedTimeout when pool maintenance runs.- Parameters:
removeAbandonedOnMaintenance- true means abandoned objects will be removed by pool maintenance- See Also:
-
setRemoveAbandonedTimeout
Sets the timeout before an abandoned object can be removed.Setting this property has no effect if
removeAbandonedOnBorrowandremoveAbandonedOnMaintenanceare both false.- Parameters:
removeAbandonedTimeout- new abandoned timeout- Since:
- 2.10.0
- See Also:
-
setRemoveAbandonedTimeout
Deprecated.Sets the timeout in seconds before an abandoned object can be removed.Setting this property has no effect if
removeAbandonedOnBorrowandremoveAbandonedOnMaintenanceare both false.- Parameters:
removeAbandonedTimeoutSeconds- new abandoned timeout in seconds- See Also:
-
setRequireFullStackTrace
Sets the flag to require full stack traces for logging abandoned connections when enabled.- Parameters:
requireFullStackTrace- indicates whether or not full stack traces are required in abandoned connection logs- Since:
- 2.5
- See Also:
-
setUseUsageTracking
If the pool implementsUsageTracking, 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.- Parameters:
useUsageTracking- A value oftruewill enable the recording of a stack trace on every use of a pooled object
-
toString
-
getRemoveAbandonedTimeoutDuration().