|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.pool2.proxy.ProxiedKeyedObjectPool<K,V>
K
- type of the keyV
- type of the pooled objectpublic class ProxiedKeyedObjectPool<K,V>
Create a new keyed 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 | |
---|---|
ProxiedKeyedObjectPool(KeyedObjectPool<K,V> pool,
org.apache.commons.pool2.proxy.ProxySource<V> proxySource)
Create a new proxied object pool. |
Method Summary | |
---|---|
void |
addObject(K key)
Create an object using the factory or
other implementation dependent mechanism, passivate it, and then place it
in the idle object pool. |
V |
borrowObject(K key)
Obtains an instance from this pool for the specified key . |
void |
clear()
Clears the pool, removing all pooled instances (optional operation). |
void |
clear(K key)
Clears the specified pool, removing all pooled instances corresponding to the given key (optional operation). |
void |
close()
Close this pool, and free any resources associated with it. |
int |
getNumActive()
Returns the total number of instances current borrowed from this pool but not yet returned. |
int |
getNumActive(K key)
Returns the number of instances currently borrowed from but not yet returned to the pool corresponding to the given key . |
int |
getNumIdle()
Returns the total number of instances currently idle in this pool. |
int |
getNumIdle(K key)
Returns the number of instances corresponding to the given key currently idle in this pool. |
void |
invalidateObject(K key,
V proxy)
Invalidates an object from the pool. |
void |
returnObject(K key,
V 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 ProxiedKeyedObjectPool(KeyedObjectPool<K,V> pool, org.apache.commons.pool2.proxy.ProxySource<V> proxySource)
pool
- The object pool to wrapproxySource
- The source of the proxy objectsMethod Detail |
---|
public V borrowObject(K key) throws Exception, NoSuchElementException, IllegalStateException
KeyedObjectPool
key
.
Instances returned from this method will have been either newly created
with makeObject
or will be
a previously idle object and have been activated with
activateObject
and then
(optionally) validated with
validateObject
.
By contract, clients must return the borrowed object
using returnObject
,
invalidateObject
, or a related method as
defined in an implementation or sub-interface, using a key
that is equivalent
to the one used to borrow the
instance in the first place.
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 KeyedObjectPool<K,V>
key
- the key used to obtain the object
IllegalStateException
- after close
has been called on this pool
Exception
- when makeObject
throws an exception
NoSuchElementException
- when the pool is exhausted and cannot or will not return
another instancepublic void returnObject(K key, V proxy) throws Exception
KeyedObjectPool
obj
must have been obtained using
borrowObject
or a related method as defined in an
implementation or sub-interface using a key
that is
equivalent to the one used to borrow the instance in the first place.
returnObject
in interface KeyedObjectPool<K,V>
key
- the key used to obtain the objectproxy
- a borrowed
instance to be returned.
Exception
public void invalidateObject(K key, V proxy) throws Exception
KeyedObjectPool
By contract, obj
must have been obtained
using borrowObject
or a related method as defined
in an implementation or sub-interface using a key
that is
equivalent to the one used to borrow the Object
in the first
place.
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 KeyedObjectPool<K,V>
key
- the key used to obtain the objectproxy
- a borrowed
instance to be returned.
Exception
public void addObject(K key) throws Exception, IllegalStateException, UnsupportedOperationException
KeyedObjectPool
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 KeyedObjectPool<K,V>
key
- the key a new instance should be added to
Exception
- when KeyedPooledObjectFactory.makeObject(K)
fails.
IllegalStateException
- after KeyedObjectPool.close()
has been called on this pool.
UnsupportedOperationException
- when this pool cannot add new idle objects.public int getNumIdle(K key)
KeyedObjectPool
key
currently idle in this pool. Returns a negative value if
this information is not available.
getNumIdle
in interface KeyedObjectPool<K,V>
key
- the key to query
key
currently idle in this pool.public int getNumActive(K key)
KeyedObjectPool
key
.
Returns a negative value if this information is not available.
getNumActive
in interface KeyedObjectPool<K,V>
key
- the key to query
key
.
=public int getNumIdle()
KeyedObjectPool
getNumIdle
in interface KeyedObjectPool<K,V>
public int getNumActive()
KeyedObjectPool
getNumActive
in interface KeyedObjectPool<K,V>
public void clear() throws Exception, UnsupportedOperationException
KeyedObjectPool
clear
in interface KeyedObjectPool<K,V>
UnsupportedOperationException
- when this implementation doesn't
support the operation
Exception
public void clear(K key) throws Exception, UnsupportedOperationException
KeyedObjectPool
key
(optional operation).
clear
in interface KeyedObjectPool<K,V>
key
- the key to clear
UnsupportedOperationException
- when this implementation doesn't
support the operation
Exception
public void close()
KeyedObjectPool
Calling addObject
or
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 KeyedObjectPool<K,V>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |