Package org.apache.tomcat.dbcp.pool2
Interface PooledObject<T>
-
- Type Parameters:
T
- the type of object in the pool
- All Superinterfaces:
Comparable<PooledObject<T>>
- All Known Implementing Classes:
DefaultPooledObject
,PooledSoftReference
public interface PooledObject<T> extends Comparable<PooledObject<T>>
Defines the wrapper that is used to track the additional information, such as state, for the pooled objects.Implementations of this class are required to be thread-safe.
- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description boolean
allocate()
Allocates the object.int
compareTo(PooledObject<T> other)
Orders instances based on idle time - i.e. the length of time since the instance was returned to the pool.boolean
deallocate()
boolean
endEvictionTest(Deque<PooledObject<T>> idleQueue)
Notifies the object that the eviction test has ended.boolean
equals(Object obj)
default Duration
getActiveDuration()
Gets the amount of time this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).default Duration
getActiveTime()
Deprecated.UsegetActiveDuration()
.long
getActiveTimeMillis()
Deprecated.UsegetActiveTime()
which offers the best precision.default long
getBorrowedCount()
Gets the number of times this object has been borrowed.default Instant
getCreateInstant()
Gets the time (using the same basis asInstant.now()
) that this object was created.long
getCreateTime()
Deprecated.UsegetCreateInstant()
which offers the best precision.default Duration
getFullDuration()
Computes the duration since this object was created (usingInstant.now()
).default Duration
getIdleDuration()
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).default Duration
getIdleTime()
Deprecated.UsegetIdleDuration()
.long
getIdleTimeMillis()
Deprecated.UsegetIdleTime()
which offers the best precision.default Instant
getLastBorrowInstant()
Gets the time the wrapped object was last borrowed.long
getLastBorrowTime()
Deprecated.UsegetLastBorrowInstant()
which offers the best precision.default Instant
getLastReturnInstant()
Gets the time the wrapped object was last borrowed.long
getLastReturnTime()
Deprecated.UsegetLastReturnInstant()
which offers the best precision.default Instant
getLastUsedInstant()
Gets an estimate of the last time this object was used.long
getLastUsedTime()
Deprecated.UsegetLastUsedInstant()
which offers the best precision.T
getObject()
Gets the underlying object that is wrapped by this instance ofPooledObject
.PooledObjectState
getState()
Gets the state of this object.int
hashCode()
void
invalidate()
Sets the state toINVALID
.void
markAbandoned()
Marks the pooled object as abandoned.void
markReturning()
Marks the object as returning to the pool.void
printStackTrace(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.void
setLogAbandoned(boolean logAbandoned)
Sets whether to use abandoned object tracking.default void
setRequireFullStackTrace(boolean requireFullStackTrace)
Sets the stack trace generation strategy based on whether or not fully detailed stack traces are required.boolean
startEvictionTest()
Attempts to place the pooled object in thePooledObjectState.EVICTION
state.String
toString()
Gets a String form of the wrapper for debug purposes.void
use()
Records the current stack trace as the last time the object was used.
-
-
-
Method Detail
-
allocate
boolean allocate()
Allocates the object.- Returns:
true
if the original state wasIDLE
-
compareTo
int compareTo(PooledObject<T> other)
Orders 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:
compareTo
in interfaceComparable<T>
-
deallocate
boolean deallocate()
- Returns:
true
if the state wasALLOCATED
.
-
endEvictionTest
boolean endEvictionTest(Deque<PooledObject<T>> idleQueue)
Notifies the object that the eviction test has ended.- Parameters:
idleQueue
- The queue of idle objects to which the object should be returned.- Returns:
- Currently not used.
-
getActiveDuration
default Duration getActiveDuration()
Gets the amount of time this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).- Returns:
- The duration last spent in the active state.
- Since:
- 2.11.0
-
getActiveTime
@Deprecated default Duration getActiveTime()
Deprecated.UsegetActiveDuration()
.Gets the amount of time this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).- Returns:
- The duration last spent in the active state.
- Since:
- 2.10.0
-
getActiveTimeMillis
@Deprecated long getActiveTimeMillis()
Deprecated.UsegetActiveTime()
which offers the best precision.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).- Returns:
- The time in milliseconds last spent in the active state.
-
getBorrowedCount
default long getBorrowedCount()
Gets the number of times this object has been borrowed.- Returns:
- -1 by default for implementations prior to release 2.7.0.
- Since:
- 2.7.0
-
getCreateInstant
default Instant getCreateInstant()
Gets the time (using the same basis asInstant.now()
) that this object was created.- Returns:
- The creation time for the wrapped object.
- Since:
- 2.11.0
-
getCreateTime
@Deprecated long getCreateTime()
Deprecated.UsegetCreateInstant()
which offers the best precision.Gets the time (using the same basis asSystem.currentTimeMillis()
) that this object was created.- Returns:
- The creation time for the wrapped object.
-
getFullDuration
default Duration getFullDuration()
Computes the duration since this object was created (usingInstant.now()
).- Returns:
- The duration since this object was created.
- Since:
- 2.12.0
-
getIdleDuration
default Duration getIdleDuration()
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).- Returns:
- The amount of time in last spent in the idle state.
- Since:
- 2.11.0
-
getIdleTime
@Deprecated default Duration getIdleTime()
Deprecated.UsegetIdleDuration()
.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).- Returns:
- The amount of time in last spent in the idle state.
- Since:
- 2.10.0
-
getIdleTimeMillis
@Deprecated long getIdleTimeMillis()
Deprecated.UsegetIdleTime()
which offers the best precision.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).- Returns:
- The time in milliseconds last spent in the idle state.
-
getLastBorrowInstant
default Instant getLastBorrowInstant()
Gets the time the wrapped object was last borrowed.- Returns:
- The time the object was last borrowed.
- Since:
- 2.11.0
-
getLastBorrowTime
@Deprecated long getLastBorrowTime()
Deprecated.UsegetLastBorrowInstant()
which offers the best precision.Gets the time the wrapped object was last borrowed.- Returns:
- The time the object was last borrowed.
-
getLastReturnInstant
default Instant getLastReturnInstant()
Gets the time the wrapped object was last borrowed.- Returns:
- The time the object was last borrowed.
- Since:
- 2.11.0
-
getLastReturnTime
@Deprecated long getLastReturnTime()
Deprecated.UsegetLastReturnInstant()
which offers the best precision.Gets the time the wrapped object was last returned.- Returns:
- The time the object was last returned.
-
getLastUsedInstant
default 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()
.- Returns:
- the last time this object was used
- Since:
- 2.11.0
-
getLastUsedTime
@Deprecated long getLastUsedTime()
Deprecated.UsegetLastUsedInstant()
which offers the best precision.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()
.- Returns:
- the last time this object was used.
-
getObject
T getObject()
Gets the underlying object that is wrapped by this instance ofPooledObject
.- Returns:
- The wrapped object.
-
getState
PooledObjectState getState()
Gets the state of this object.- Returns:
- state
-
invalidate
void invalidate()
Sets the state toINVALID
.
-
markAbandoned
void markAbandoned()
Marks the pooled object as abandoned.
-
markReturning
void markReturning()
Marks the object as returning to the pool.
-
printStackTrace
void printStackTrace(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.- Parameters:
writer
- The destination for the debug output.
-
setLogAbandoned
void setLogAbandoned(boolean logAbandoned)
Sets 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.- Parameters:
logAbandoned
- The new configuration setting for abandoned object tracking.
-
setRequireFullStackTrace
default void setRequireFullStackTrace(boolean requireFullStackTrace)
Sets 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.- Parameters:
requireFullStackTrace
- the new configuration setting for abandoned object logging.- Since:
- 2.7.0
-
startEvictionTest
boolean startEvictionTest()
Attempts to place the pooled object in thePooledObjectState.EVICTION
state.- Returns:
true
if the object was placed in thePooledObjectState.EVICTION
state otherwisefalse
.
-
toString
String toString()
Gets a String form of the wrapper for debug purposes. The format is not fixed and may change at any time.
-
use
void use()
Records the current stack trace as the last time the object was used.
-
-