Class DefaultPooledObject<T>
- java.lang.Object
-
- org.apache.tomcat.dbcp.pool2.impl.DefaultPooledObject<T>
-
- Type Parameters:
T- the type of object in the pool
- All Implemented Interfaces:
Comparable<PooledObject<T>>,PooledObject<T>
- Direct Known Subclasses:
PooledSoftReference
public class DefaultPooledObject<T> extends Object implements PooledObject<T>
This wrapper is used to track the additional information, such as state, for the pooled objects.This class is intended to be thread-safe.
- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description DefaultPooledObject(T object)Creates a new instance that wraps the provided object so that the pool can track the state of the pooled object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanallocate()Allocates the object.intcompareTo(PooledObject<T> other)Orders instances based on idle time - i.e. the length of time since the instance was returned to the pool.booleandeallocate()booleanendEvictionTest(Deque<PooledObject<T>> idleQueue)Notifies the object that the eviction test has ended.longgetActiveTimeMillis()Gets the amount of time in milliseconds this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).longgetBorrowedCount()Gets the number of times this object has been borrowed.InstantgetCreateInstant()Gets the time (using the same basis asInstant.now()) that this object was created.longgetCreateTime()Gets the time (using the same basis asClock.instant()) that this object was created.DurationgetIdleDuration()Gets the amount of time that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).DurationgetIdleTime()Gets the amount of time that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).longgetIdleTimeMillis()Gets the amount of time in milliseconds that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).InstantgetLastBorrowInstant()Gets the time the wrapped object was last borrowed.longgetLastBorrowTime()Gets the time the wrapped object was last borrowed.InstantgetLastReturnInstant()Gets the time the wrapped object was last borrowed.longgetLastReturnTime()Gets the time the wrapped object was last returned.InstantgetLastUsedInstant()Gets an estimate of the last time this object was used.longgetLastUsedTime()Gets an estimate of the last time this object was used.TgetObject()Gets the underlying object that is wrapped by this instance ofPooledObject.PooledObjectStategetState()Gets the state of this object.voidinvalidate()Sets the state toINVALID.voidmarkAbandoned()Marks the pooled object asABANDONED.voidmarkReturning()Marks the pooled object asRETURNING.voidprintStackTrace(PrintWriter writer)Prints the stack trace of the code that borrowed this pooled object and the stack trace of the last code to use this object (if available) to the supplied writer.voidsetLogAbandoned(boolean logAbandoned)Sets whether to use abandoned object tracking.voidsetRequireFullStackTrace(boolean requireFullStackTrace)Configures the stack trace generation strategy based on whether or not fully detailed stack traces are required.booleanstartEvictionTest()Attempts to place the pooled object in thePooledObjectState.EVICTIONstate.StringtoString()Gets a String form of the wrapper for debug purposes.voiduse()Records the current stack trace as the last time the object was used.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.tomcat.dbcp.pool2.PooledObject
equals, getActiveDuration, getActiveTime, getFullDuration, hashCode
-
-
-
-
Constructor Detail
-
DefaultPooledObject
public DefaultPooledObject(T object)
Creates a new instance that wraps the provided object so that the pool can track the state of the pooled object.- Parameters:
object- The object to wrap
-
-
Method Detail
-
allocate
public boolean allocate()
Allocates the object.- Specified by:
allocatein interfacePooledObject<T>- Returns:
trueif the original state wasIDLE
-
compareTo
public int compareTo(PooledObject<T> other)
Description copied from interface:PooledObjectOrders instances based on idle time - i.e. the length of time since the instance was returned to the pool. Used by the GKOP idle object evictor.Note: This class has a natural ordering that is inconsistent with equals if distinct objects have the same identity hash code.
- Specified by:
compareToin interfaceComparable<T>- Specified by:
compareToin interfacePooledObject<T>
-
deallocate
public boolean deallocate()
- Specified by:
deallocatein interfacePooledObject<T>- Returns:
trueif the state wasALLOCATEDorRETURNING.
-
endEvictionTest
public boolean endEvictionTest(Deque<PooledObject<T>> idleQueue)
Description copied from interface:PooledObjectNotifies the object that the eviction test has ended.- Specified by:
endEvictionTestin interfacePooledObject<T>- Parameters:
idleQueue- The queue of idle objects to which the object should be returned.- Returns:
- Currently not used.
-
getActiveTimeMillis
public long getActiveTimeMillis()
Description copied from interface:PooledObjectGets the amount of time in milliseconds this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).- Specified by:
getActiveTimeMillisin interfacePooledObject<T>- Returns:
- The time in milliseconds last spent in the active state.
-
getBorrowedCount
public long getBorrowedCount()
Gets the number of times this object has been borrowed.- Specified by:
getBorrowedCountin interfacePooledObject<T>- Returns:
- The number of times this object has been borrowed.
- Since:
- 2.1
-
getCreateInstant
public Instant getCreateInstant()
Description copied from interface:PooledObjectGets the time (using the same basis asInstant.now()) that this object was created.- Specified by:
getCreateInstantin interfacePooledObject<T>- Returns:
- The creation time for the wrapped object.
-
getCreateTime
public long getCreateTime()
Description copied from interface:PooledObjectGets the time (using the same basis asClock.instant()) that this object was created.- Specified by:
getCreateTimein interfacePooledObject<T>- Returns:
- The creation time for the wrapped object.
-
getIdleDuration
public Duration getIdleDuration()
Description copied from interface:PooledObjectGets the amount of time that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).- Specified by:
getIdleDurationin interfacePooledObject<T>- Returns:
- The amount of time in last spent in the idle state.
-
getIdleTime
public Duration getIdleTime()
Description copied from interface:PooledObjectGets the amount of time that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).- Specified by:
getIdleTimein interfacePooledObject<T>- Returns:
- The amount of time in last spent in the idle state.
-
getIdleTimeMillis
public long getIdleTimeMillis()
Description copied from interface:PooledObjectGets the amount of time in milliseconds that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).- Specified by:
getIdleTimeMillisin interfacePooledObject<T>- Returns:
- The time in milliseconds last spent in the idle state.
-
getLastBorrowInstant
public Instant getLastBorrowInstant()
Description copied from interface:PooledObjectGets the time the wrapped object was last borrowed.- Specified by:
getLastBorrowInstantin interfacePooledObject<T>- Returns:
- The time the object was last borrowed.
-
getLastBorrowTime
public long getLastBorrowTime()
Description copied from interface:PooledObjectGets the time the wrapped object was last borrowed.- Specified by:
getLastBorrowTimein interfacePooledObject<T>- Returns:
- The time the object was last borrowed.
-
getLastReturnInstant
public Instant getLastReturnInstant()
Description copied from interface:PooledObjectGets the time the wrapped object was last borrowed.- Specified by:
getLastReturnInstantin interfacePooledObject<T>- Returns:
- The time the object was last borrowed.
-
getLastReturnTime
public long getLastReturnTime()
Description copied from interface:PooledObjectGets the time the wrapped object was last returned.- Specified by:
getLastReturnTimein interfacePooledObject<T>- Returns:
- The time the object was last returned.
-
getLastUsedInstant
public Instant getLastUsedInstant()
Gets an estimate of the last time this object was used. If the class of the pooled object implementsTrackedUse, what is returned is the maximum ofTrackedUse.getLastUsedInstant()andgetLastBorrowTime(); otherwise this method gives the same value asgetLastBorrowTime().- Specified by:
getLastUsedInstantin interfacePooledObject<T>- Returns:
- the last Instant this object was used.
-
getLastUsedTime
public long getLastUsedTime()
Gets an estimate of the last time this object was used. If the class of the pooled object implementsTrackedUse, what is returned is the maximum ofTrackedUse.getLastUsedInstant()andgetLastBorrowTime(); otherwise this method gives the same value asgetLastBorrowTime().- Specified by:
getLastUsedTimein interfacePooledObject<T>- Returns:
- the last time this object was used
-
getObject
public T getObject()
Description copied from interface:PooledObjectGets the underlying object that is wrapped by this instance ofPooledObject.- Specified by:
getObjectin interfacePooledObject<T>- Returns:
- The wrapped object.
-
getState
public PooledObjectState getState()
Gets the state of this object.- Specified by:
getStatein interfacePooledObject<T>- Returns:
- state
-
invalidate
public void invalidate()
Sets the state toINVALID.- Specified by:
invalidatein interfacePooledObject<T>
-
markAbandoned
public void markAbandoned()
Marks the pooled object asABANDONED.- Specified by:
markAbandonedin interfacePooledObject<T>
-
markReturning
public void markReturning()
Marks the pooled object asRETURNING.- Specified by:
markReturningin interfacePooledObject<T>
-
printStackTrace
public void printStackTrace(PrintWriter writer)
Description copied from interface:PooledObjectPrints the stack trace of the code that borrowed this pooled object and the stack trace of the last code to use this object (if available) to the supplied writer.- Specified by:
printStackTracein interfacePooledObject<T>- Parameters:
writer- The destination for the debug output.
-
setLogAbandoned
public void setLogAbandoned(boolean logAbandoned)
Description copied from interface:PooledObjectSets whether to use abandoned object tracking. If this is true the implementation will need to record the stack trace of the last caller to borrow this object.- Specified by:
setLogAbandonedin interfacePooledObject<T>- Parameters:
logAbandoned- The new configuration setting for abandoned object tracking.
-
setRequireFullStackTrace
public void setRequireFullStackTrace(boolean requireFullStackTrace)
Configures the stack trace generation strategy based on whether or not fully detailed stack traces are required. When set to false, abandoned logs may only include caller class information rather than method names, line numbers, and other normal metadata available in a full stack trace.- Specified by:
setRequireFullStackTracein interfacePooledObject<T>- Parameters:
requireFullStackTrace- the new configuration setting for abandoned object logging- Since:
- 2.5
-
startEvictionTest
public boolean startEvictionTest()
Description copied from interface:PooledObjectAttempts to place the pooled object in thePooledObjectState.EVICTIONstate.- Specified by:
startEvictionTestin interfacePooledObject<T>- Returns:
trueif the object was placed in thePooledObjectState.EVICTIONstate otherwisefalse.
-
toString
public String toString()
Description copied from interface:PooledObjectGets a String form of the wrapper for debug purposes. The format is not fixed and may change at any time.- Specified by:
toStringin interfacePooledObject<T>- Overrides:
toStringin classObject
-
use
public void use()
Description copied from interface:PooledObjectRecords the current stack trace as the last time the object was used.- Specified by:
usein interfacePooledObject<T>
-
-