Package org.apache.commons.pool2.impl
Class DefaultPooledObject<T>
- java.lang.Object
-
- org.apache.commons.pool2.impl.DefaultPooledObject<T>
-
- Type Parameters:
T
- the type of object in the pool
- All Implemented Interfaces:
java.lang.Comparable<PooledObject<T>>
,PooledObject<T>
- Direct Known Subclasses:
PooledSoftReference
public class DefaultPooledObject<T> extends java.lang.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
- Version:
- $Revision: $
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
DefaultPooledObject.AbandonedObjectCreatedException
Used to track how an object was obtained from the pool (the stack trace of the exception will show which code borrowed the object) and when the object was borrowed.
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Exception
borrowedBy
private long
borrowedCount
private long
createTime
private long
lastBorrowTime
private long
lastReturnTime
private long
lastUseTime
private boolean
logAbandoned
private T
object
private PooledObjectState
state
private java.lang.Exception
usedBy
-
Constructor Summary
Constructors Constructor Description DefaultPooledObject(T object)
Create 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 boolean
allocate()
Allocates the object.int
compareTo(PooledObject<T> other)
Orders instances based on idle time - i.e.boolean
deallocate()
boolean
endEvictionTest(java.util.Deque<PooledObject<T>> idleQueue)
Called to inform the object that the eviction test has ended.long
getActiveTimeMillis()
Obtain the time in milliseconds that this object last spent in the the active state (it may still be active in which case subsequent calls will return an increased value).long
getBorrowedCount()
Get the number of times this object has been borrowed.long
getCreateTime()
Obtain the time (using the same basis asSystem.currentTimeMillis()
) that this object was created.long
getIdleTimeMillis()
Obtain the time in milliseconds that this object last spend in the the idle state (it may still be idle in which case subsequent calls will return an increased value).long
getLastBorrowTime()
Obtain the time the wrapped object was last borrowed.long
getLastReturnTime()
Obtain the time the wrapped object was last returned.long
getLastUsedTime()
Return an estimate of the last time this object was used.T
getObject()
Obtain the underlying object that is wrapped by this instance ofPooledObject
.PooledObjectState
getState()
Returns the state of this object.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(java.io.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)
Is abandoned object tracking being used? If this is true the implementation will need to record the stack trace of the last caller to borrow this object.boolean
startEvictionTest()
Attempt to place the pooled object in thePooledObjectState.EVICTION
state.java.lang.String
toString()
Provides a String form of the wrapper for debug purposes.void
use()
Record 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.commons.pool2.PooledObject
equals, hashCode
-
-
-
-
Field Detail
-
object
private final T object
-
state
private PooledObjectState state
-
createTime
private final long createTime
-
lastBorrowTime
private volatile long lastBorrowTime
-
lastUseTime
private volatile long lastUseTime
-
lastReturnTime
private volatile long lastReturnTime
-
logAbandoned
private volatile boolean logAbandoned
-
borrowedBy
private volatile java.lang.Exception borrowedBy
-
usedBy
private volatile java.lang.Exception usedBy
-
borrowedCount
private volatile long borrowedCount
-
-
Constructor Detail
-
DefaultPooledObject
public DefaultPooledObject(T object)
Create 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
-
getObject
public T getObject()
Description copied from interface:PooledObject
Obtain the underlying object that is wrapped by this instance ofPooledObject
.- Specified by:
getObject
in interfacePooledObject<T>
- Returns:
- The wrapped object
-
getCreateTime
public long getCreateTime()
Description copied from interface:PooledObject
Obtain the time (using the same basis asSystem.currentTimeMillis()
) that this object was created.- Specified by:
getCreateTime
in interfacePooledObject<T>
- Returns:
- The creation time for the wrapped object
-
getActiveTimeMillis
public long getActiveTimeMillis()
Description copied from interface:PooledObject
Obtain the time in milliseconds that this object last spent in the the active state (it may still be active in which case subsequent calls will return an increased value).- Specified by:
getActiveTimeMillis
in interfacePooledObject<T>
- Returns:
- The time in milliseconds last spent in the active state
-
getIdleTimeMillis
public long getIdleTimeMillis()
Description copied from interface:PooledObject
Obtain the time in milliseconds that this object last spend in the the idle state (it may still be idle in which case subsequent calls will return an increased value).- Specified by:
getIdleTimeMillis
in interfacePooledObject<T>
- Returns:
- The time in milliseconds last spent in the idle state
-
getLastBorrowTime
public long getLastBorrowTime()
Description copied from interface:PooledObject
Obtain the time the wrapped object was last borrowed.- Specified by:
getLastBorrowTime
in interfacePooledObject<T>
- Returns:
- The time the object was last borrowed
-
getLastReturnTime
public long getLastReturnTime()
Description copied from interface:PooledObject
Obtain the time the wrapped object was last returned.- Specified by:
getLastReturnTime
in interfacePooledObject<T>
- Returns:
- The time the object was last returned
-
getBorrowedCount
public long getBorrowedCount()
Get the number of times this object has been borrowed.- Returns:
- The number of times this object has been borrowed.
- Since:
- 2.1
-
getLastUsedTime
public long getLastUsedTime()
Return 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.getLastUsed()
andgetLastBorrowTime()
; otherwise this method gives the same value asgetLastBorrowTime()
.- Specified by:
getLastUsedTime
in interfacePooledObject<T>
- Returns:
- the last time this object was used
-
compareTo
public int compareTo(PooledObject<T> other)
Description copied from interface:PooledObject
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 interfacejava.lang.Comparable<T>
- Specified by:
compareTo
in interfacePooledObject<T>
-
toString
public java.lang.String toString()
Description copied from interface:PooledObject
Provides a String form of the wrapper for debug purposes. The format is not fixed and may change at any time.- Specified by:
toString
in interfacePooledObject<T>
- Overrides:
toString
in classjava.lang.Object
-
startEvictionTest
public boolean startEvictionTest()
Description copied from interface:PooledObject
Attempt to place the pooled object in thePooledObjectState.EVICTION
state.- Specified by:
startEvictionTest
in interfacePooledObject<T>
- Returns:
true
if the object was placed in thePooledObjectState.EVICTION
state otherwisefalse
-
endEvictionTest
public boolean endEvictionTest(java.util.Deque<PooledObject<T>> idleQueue)
Description copied from interface:PooledObject
Called to inform the object that the eviction test has ended.- Specified by:
endEvictionTest
in interfacePooledObject<T>
- Parameters:
idleQueue
- The queue of idle objects to which the object should be returned- Returns:
- Currently not used
-
allocate
public boolean allocate()
Allocates the object.- Specified by:
allocate
in interfacePooledObject<T>
- Returns:
true
if the original state wasIDLE
-
deallocate
public boolean deallocate()
- Specified by:
deallocate
in interfacePooledObject<T>
- Returns:
true
if the state wasALLOCATED
-
invalidate
public void invalidate()
Sets the state toINVALID
- Specified by:
invalidate
in interfacePooledObject<T>
-
use
public void use()
Description copied from interface:PooledObject
Record the current stack trace as the last time the object was used.- Specified by:
use
in interfacePooledObject<T>
-
printStackTrace
public void printStackTrace(java.io.PrintWriter writer)
Description copied from interface:PooledObject
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.- Specified by:
printStackTrace
in interfacePooledObject<T>
- Parameters:
writer
- The destination for the debug output
-
getState
public PooledObjectState getState()
Returns the state of this object.- Specified by:
getState
in interfacePooledObject<T>
- Returns:
- state
-
markAbandoned
public void markAbandoned()
Marks the pooled object as abandoned.- Specified by:
markAbandoned
in interfacePooledObject<T>
-
markReturning
public void markReturning()
Marks the object as returning to the pool.- Specified by:
markReturning
in interfacePooledObject<T>
-
setLogAbandoned
public void setLogAbandoned(boolean logAbandoned)
Description copied from interface:PooledObject
Is abandoned object tracking being used? If this is true the implementation will need to record the stack trace of the last caller to borrow this object.- Specified by:
setLogAbandoned
in interfacePooledObject<T>
- Parameters:
logAbandoned
- The new configuration setting for abandoned object tracking
-
-