private static class PoolUtils.SynchronizedKeyedObjectPool<K,V> extends java.lang.Object implements KeyedObjectPool<K,V>
Note:
This should not be used on pool implementations that already provide proper synchronization
such as the pools provided in the Commons Pool library. Wrapping a pool that
waits
for poolable objects to be returned before allowing another one to be
borrowed with another layer of synchronization will cause liveliness issues or a deadlock.
Modifier and Type | Field and Description |
---|---|
private KeyedObjectPool<K,V> |
keyedPool
Underlying object pool
|
private java.lang.Object |
lock
Object whose monitor is used to synchronize methods on the wrapped pool.
|
Constructor and Description |
---|
SynchronizedKeyedObjectPool(KeyedObjectPool<K,V> keyedPool)
Create a new SynchronizedKeyedObjectPool wrapping the given pool
|
Modifier and Type | Method and Description |
---|---|
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 (optional operation).
|
int |
getNumActive(K key)
Returns the number of instances
currently borrowed from but not yet returned
to the pool corresponding to the
given
key (optional operation). |
int |
getNumIdle()
Returns the total number of instances
currently idle in this pool (optional operation).
|
int |
getNumIdle(K key)
Returns the number of instances
corresponding to the given
key
currently idle in this pool (optional operation). |
void |
invalidateObject(K key,
V obj)
Invalidates an object from the pool.
|
void |
returnObject(K key,
V obj)
Return an instance to the pool.
|
void |
setFactory(KeyedPoolableObjectFactory<K,V> factory)
Deprecated.
to be removed in pool 2.0
|
java.lang.String |
toString() |
private final java.lang.Object lock
private final KeyedObjectPool<K,V> keyedPool
SynchronizedKeyedObjectPool(KeyedObjectPool<K,V> keyedPool) throws java.lang.IllegalArgumentException
keyedPool
- KeyedObjectPool to wrapjava.lang.IllegalArgumentException
- if keyedPool is nullpublic V borrowObject(K key) throws java.lang.Exception, java.util.NoSuchElementException, java.lang.IllegalStateException
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 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).
Older versions of this method would return null
to indicate exhaustion,
newer versions are encouraged to throw a NoSuchElementException
.
borrowObject
in interface KeyedObjectPool<K,V>
key
- the key used to obtain the objectjava.lang.IllegalStateException
- after close
has been called on this pooljava.lang.Exception
- when makeObject
throws an exceptionjava.util.NoSuchElementException
- when the pool is exhausted and cannot or will not return another instancepublic void returnObject(K key, V obj)
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 objectobj
- a borrowed
instance to be returned.public void invalidateObject(K key, V obj)
Invalidates an object from the pool.
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 objectobj
- a borrowed
instance to be returned.public void addObject(K key) throws java.lang.Exception, java.lang.IllegalStateException, java.lang.UnsupportedOperationException
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 tojava.lang.Exception
- when KeyedPoolableObjectFactory.makeObject(K)
fails.java.lang.IllegalStateException
- after KeyedObjectPool.close()
has been called on this pool.java.lang.UnsupportedOperationException
- when this pool cannot add new idle objects.public int getNumIdle(K key) throws java.lang.UnsupportedOperationException
key
currently idle in this pool (optional operation).
Returns a negative value if this information is not available.getNumIdle
in interface KeyedObjectPool<K,V>
key
- the key to querykey
currently idle in this pool or a negative value if unsupportedjava.lang.UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumActive(K key) throws java.lang.UnsupportedOperationException
key
(optional operation).
Returns a negative value if this information is not available.getNumActive
in interface KeyedObjectPool<K,V>
key
- the key to querykey
currently borrowed in this pool or a negative value if unsupportedjava.lang.UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumIdle() throws java.lang.UnsupportedOperationException
getNumIdle
in interface KeyedObjectPool<K,V>
java.lang.UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumActive() throws java.lang.UnsupportedOperationException
getNumActive
in interface KeyedObjectPool<K,V>
java.lang.UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic void clear() throws java.lang.Exception, java.lang.UnsupportedOperationException
UnsupportedOperationException
if the pool cannot be cleared.clear
in interface KeyedObjectPool<K,V>
java.lang.UnsupportedOperationException
- when this implementation doesn't support the operationjava.lang.Exception
public void clear(K key) throws java.lang.Exception, java.lang.UnsupportedOperationException
key
(optional operation).
Throws UnsupportedOperationException
if the pool cannot be cleared.clear
in interface KeyedObjectPool<K,V>
key
- the key to clearjava.lang.UnsupportedOperationException
- when this implementation doesn't support the operationjava.lang.Exception
public void close()
Calling addObject
or borrowObject
after invoking
this method on a pool will cause them to throw an IllegalStateException
.
close
in interface KeyedObjectPool<K,V>
@Deprecated public void setFactory(KeyedPoolableObjectFactory<K,V> factory) throws java.lang.IllegalStateException, java.lang.UnsupportedOperationException
setFactory
in interface KeyedObjectPool<K,V>
factory
- KeyedPoolableObjectFactory used by the pooljava.lang.IllegalStateException
- when the factory cannot be set at this timejava.lang.UnsupportedOperationException
- when this implementation doesn't support the operationpublic java.lang.String toString()
toString
in class java.lang.Object