|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.pool2.proxy.ProxiedObjectPool<T>
T
- type of the pooled objectpublic class ProxiedObjectPool<T>
Create a new object pool where the pooled objects are wrapped in proxies allowing better control of pooled objects and in particular the prevention of the continued use of an object by a client after that client returns the object to the pool.
Constructor Summary | |
---|---|
ProxiedObjectPool(ObjectPool<T> pool,
org.apache.commons.pool2.proxy.ProxySource<T> proxySource)
Create a new proxied object pool. |
Method Summary | |
---|---|
void |
addObject()
Create an object using the factory or other
implementation dependent mechanism, passivate it, and then place it in
the idle object pool. |
T |
borrowObject()
Obtains an instance from this pool. |
void |
clear()
Clears any objects sitting idle in the pool, releasing any associated resources (optional operation). |
void |
close()
Close this pool, and free any resources associated with it. |
int |
getNumActive()
Return the number of instances currently borrowed from this pool. |
int |
getNumIdle()
Return the number of instances currently idle in this pool. |
void |
invalidateObject(T proxy)
Invalidates an object from the pool. |
void |
returnObject(T proxy)
Return an instance to the pool. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProxiedObjectPool(ObjectPool<T> pool, org.apache.commons.pool2.proxy.ProxySource<T> proxySource)
pool
- The object pool to wrapproxySource
- The source of the proxy objectsMethod Detail |
---|
public T borrowObject() throws Exception, NoSuchElementException, IllegalStateException
ObjectPool
Instances returned from this method will have been either newly created
with PooledObjectFactory.makeObject()
or will be a previously
idle object and have been activated with
PooledObjectFactory.activateObject(org.apache.commons.pool2.PooledObject
and then validated with
PooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject
.
By contract, clients must return the borrowed instance
using ObjectPool.returnObject(T)
, ObjectPool.invalidateObject(T)
, or a related
method as defined in an implementation or sub-interface.
The behaviour of this method when the pool has been exhausted is not strictly specified (although it may be specified by implementations).
borrowObject
in interface ObjectPool<T>
IllegalStateException
- after close
has been called on this pool.
Exception
- when PooledObjectFactory.makeObject()
throws an
exception.
NoSuchElementException
- when the pool is exhausted and cannot or will not return
another instance.public void returnObject(T proxy) throws Exception
ObjectPool
obj
must have been obtained using ObjectPool.borrowObject()
or
a related method as defined in an implementation or sub-interface.
returnObject
in interface ObjectPool<T>
proxy
- a borrowed
instance to be returned.
Exception
public void invalidateObject(T proxy) throws Exception
ObjectPool
By contract, obj
must have been obtained
using ObjectPool.borrowObject()
or a related method as defined in an
implementation or sub-interface.
This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid.
invalidateObject
in interface ObjectPool<T>
proxy
- a borrowed
instance to be disposed.
Exception
public void addObject() throws Exception, IllegalStateException, UnsupportedOperationException
ObjectPool
factory
or other
implementation dependent mechanism, passivate it, and then place it in
the idle object pool. addObject
is useful for "pre-loading"
a pool with idle objects. (Optional operation).
addObject
in interface ObjectPool<T>
Exception
- when PooledObjectFactory.makeObject()
fails.
IllegalStateException
- after ObjectPool.close()
has been called on this pool.
UnsupportedOperationException
- when this pool cannot add new idle objects.public int getNumIdle()
ObjectPool
borrowed
without creating any new instances.
Returns a negative value if this information is not available.
getNumIdle
in interface ObjectPool<T>
public int getNumActive()
ObjectPool
getNumActive
in interface ObjectPool<T>
public void clear() throws Exception, UnsupportedOperationException
ObjectPool
PooledObjectFactory.destroyObject(PooledObject)
.
clear
in interface ObjectPool<T>
UnsupportedOperationException
- if this implementation does not support the operation
Exception
public void close()
ObjectPool
Calling ObjectPool.addObject()
or ObjectPool.borrowObject()
after invoking this
method on a pool will cause them to throw an IllegalStateException
.
Implementations should silently fail if not all resources can be freed.
close
in interface ObjectPool<T>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |