de.aristaflow.adept2.util.objectpool.generic

Interface ObjectPoolListener<T>

Type Parameters:

T - the type of objects managed by the object pool

public interface ObjectPoolListener<T>

The intended purpose of this interface is to provide basic information that concerns how the pool is used by borrowers and which is otherwise hard to come by. This is e.g. helpful to provide domain-specific log messages ("Someone forgot to close a connection!" instead of "The object xy was not returned to the object pool!").

Author:

Patrick Schmidt

Method Summary

Modifier and Type	Method and Description
void	objectCheckedIn(T object, CallerTrace checkOutTrace, CallerTrace checkInTrace, PoolStats poolStats) Called after an object was checked into the pool.
void	objectCheckedOut(T object, CallerTrace checkOutTrace, PoolStats poolStats) Called after an object was checked out from the pool.
void	objectCreated(T object, int objectCount) Called after an object was created by the pool.
void	objectDestroyed(T object, int objectCount, java.lang.Exception ex) Called after an object was destroyed by the pool.
void	objectReclaimed(T object, ReclaimAction reclaimAction, CallerTrace checkOutTrace) Called after the reclaiming of an object was triggered.

Method Detail

objectCreated

void objectCreated(T object,
                   int objectCount)

Called after an object was created by the pool.

Parameters:

object - the created object

objectCount - the new number of objects managed by the pool

objectCheckedOut

void objectCheckedOut(T object,
                      CallerTrace checkOutTrace,
                      PoolStats poolStats)

Called after an object was checked out from the pool.

Parameters:

object - the checked out object

checkOutTrace - the caller trace of the burrower; may be null if the pool does not record it

poolStats - the current stats of the pool

objectCheckedIn

void objectCheckedIn(T object,
                     CallerTrace checkOutTrace,
                     CallerTrace checkInTrace,
                     PoolStats poolStats)

Called after an object was checked into the pool.

Parameters:

object - the checked in object

checkOutTrace - the caller trace of the original (!!) burrower, not the one who returned it; may be null if the pool does not record it

checkInTrace - the caller trace of the check-in of the object

poolStats - the current stats of the pool

objectReclaimed

void objectReclaimed(T object,
                     ReclaimAction reclaimAction,
                     CallerTrace checkOutTrace)

Called after the reclaiming of an object was triggered.

Parameters:

object - the reclaimed object (see the ReclaimAction)

reclaimAction - what was done exactly (depends on the pool's configuration)

checkOutTrace - the caller trace of the burrower; may be null if the pool does not record it

objectDestroyed

void objectDestroyed(T object,
                     int objectCount,
                     java.lang.Exception ex)

Called after an object was destroyed by the pool.

Parameters:

object - the destroyed object

objectCount - the remaining number of objects managed by the pool

ex - the exception if one was encountered in the process of the destroying the object