org.apache.avalon.excalibur.pool
Class TraceableResourceLimitingPool
java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.avalon.excalibur.pool.InstrumentedResourceLimitingPool
org.apache.avalon.excalibur.pool.TraceableResourceLimitingPool
- All Implemented Interfaces:
- Pool, org.apache.avalon.framework.activity.Disposable, LogEnabled, org.apache.avalon.framework.thread.ThreadSafe, Instrumentable
- Direct Known Subclasses:
- ValidatedResourceLimitingPool
public class TraceableResourceLimitingPool
- extends InstrumentedResourceLimitingPool
A ResourceLimitingPool which can be configured so that it will trace the
where get is being called fron. The pool can then be queried for its
status.
- Since:
- 4.1
- Version:
- CVS $Revision: 1.6 $ $Date: 2004/03/31 08:07:28 $
- Author:
- Avalon Development Team
Constructor Summary |
TraceableResourceLimitingPool(ObjectFactory factory,
int max,
boolean maxStrict,
boolean blocking,
long blockTimeout,
long trimInterval,
boolean trace)
Creates a new TraceableResourceLimitingPool |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TraceableResourceLimitingPool
public TraceableResourceLimitingPool(ObjectFactory factory,
int max,
boolean maxStrict,
boolean blocking,
long blockTimeout,
long trimInterval,
boolean trace)
- Creates a new TraceableResourceLimitingPool
- Parameters:
factory
- The ObjectFactory which will be used to create new Poolables as needed by
the pool.max
- Maximum number of Poolables which can be stored in the pool, 0 implies no limit.maxStrict
- true if the pool should never allow more than max Poolable to be created.
Will cause an exception to be thrown if more than max Poolables are requested and blocking
is false.blocking
- true if the pool should cause a thread calling get() to block when Poolables
are not currently available on the pool.blockTimeout
- The maximum amount of time, in milliseconds, that a call to get() will
block before an exception is thrown. A value of 0 implies an indefinate wait.trimInterval
- The minimum interval with which old unused poolables will be removed
from the pool. A value of 0 will cause the pool to never trim poolables.trace
- True if tracing of gets is enabled for the pool.
get
public Poolable get()
throws Exception
- Gets a Poolable from the pool. If there is room in the pool, a new Poolable will be
created. Depending on the parameters to the constructor, the method may block or throw
an exception if a Poolable is not available on the pool.
- Specified by:
get
in interface Pool
- Overrides:
get
in class InstrumentedResourceLimitingPool
- Returns:
- Always returns a Poolable. Contract requires that put must always be called with
the Poolable returned.
- Throws:
Exception
- An exception may be thrown as described above or if there is an exception
thrown by the ObjectFactory's newInstance() method.
put
public void put(Poolable poolable)
- Returns a poolable to the pool and notifies any thread blocking.
- Specified by:
put
in interface Pool
- Overrides:
put
in class InstrumentedResourceLimitingPool
- Parameters:
poolable
- Poolable to return to the pool.
removePoolable
protected void removePoolable(Poolable poolable)
- Called when an object is being removed permanently from the pool.
This is the method to override when you need to enforce destructional
policies.
This method is only called by threads that have m_semaphore locked.
- Overrides:
removePoolable
in class InstrumentedResourceLimitingPool
- Parameters:
poolable
- Poolable to be completely removed from the pool.
getState
public TraceableResourceLimitingPool.State getState()
- Returns a snapshot of the current state of the pool.
- Returns:
- A snapshot of the current pool state.
Copyright © 1997-2012 Apache Software Foundation. All Rights Reserved.