Class PoolUtils.SynchronizedKeyedObjectPool<K,V>
- java.lang.Object
-
- org.apache.commons.pool2.PoolUtils.SynchronizedKeyedObjectPool<K,V>
-
- All Implemented Interfaces:
KeyedObjectPool<K,V>
- Enclosing class:
- PoolUtils
private static class PoolUtils.SynchronizedKeyedObjectPool<K,V> extends java.lang.Object implements KeyedObjectPool<K,V>
A synchronized (thread-safe) KeyedObjectPool backed by the specified KeyedObjectPool.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.
-
-
Field Summary
Fields Modifier and Type Field Description private KeyedObjectPool<K,V>
keyedPool
Underlying object poolprivate java.util.concurrent.locks.ReentrantReadWriteLock
readWriteLock
Object whose monitor is used to synchronize methods on the wrapped pool.
-
Constructor Summary
Constructors Constructor Description SynchronizedKeyedObjectPool(KeyedObjectPool<K,V> keyedPool)
Create a new SynchronizedKeyedObjectPool wrapping the given pool
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addObject(K key)
Create an object using thefactory
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 specifiedkey
.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 givenkey
(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 givenkey
.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 givenkey
currently idle in this pool.void
invalidateObject(K key, V obj)
Invalidates an object from the pool.void
returnObject(K key, V obj)
Return an instance to the pool.java.lang.String
toString()
-
-
-
Field Detail
-
readWriteLock
private final java.util.concurrent.locks.ReentrantReadWriteLock readWriteLock
Object whose monitor is used to synchronize methods on the wrapped pool.
-
keyedPool
private final KeyedObjectPool<K,V> keyedPool
Underlying object pool
-
-
Constructor Detail
-
SynchronizedKeyedObjectPool
SynchronizedKeyedObjectPool(KeyedObjectPool<K,V> keyedPool) throws java.lang.IllegalArgumentException
Create a new SynchronizedKeyedObjectPool wrapping the given pool- Parameters:
keyedPool
- KeyedObjectPool to wrap- Throws:
java.lang.IllegalArgumentException
- if keyedPool is null
-
-
Method Detail
-
borrowObject
public V borrowObject(K key) throws java.lang.Exception, java.util.NoSuchElementException, java.lang.IllegalStateException
Obtains an instance from this pool for the specifiedkey
.Instances returned from this method will have been either newly created with
makeObject
or will be a previously idle object and have been activated withactivateObject
and then (optionally) validated withvalidateObject
.By contract, clients must return the borrowed object using
returnObject
,invalidateObject
, or a related method as defined in an implementation or sub-interface, using akey
that isequivalent
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).
- Specified by:
borrowObject
in interfaceKeyedObjectPool<K,V>
- Parameters:
key
- the key used to obtain the object- Returns:
- an instance from this pool.
- Throws:
java.lang.IllegalStateException
- afterclose
has been called on this pooljava.lang.Exception
- whenmakeObject
throws an exceptionjava.util.NoSuchElementException
- when the pool is exhausted and cannot or will not return another instance
-
returnObject
public void returnObject(K key, V obj)
Return an instance to the pool. By contract,obj
must have been obtained usingborrowObject
or a related method as defined in an implementation or sub-interface using akey
that is equivalent to the one used to borrow the instance in the first place.- Specified by:
returnObject
in interfaceKeyedObjectPool<K,V>
- Parameters:
key
- the key used to obtain the objectobj
- aborrowed
instance to be returned.
-
invalidateObject
public void invalidateObject(K key, V obj)
Invalidates an object from the pool.By contract,
obj
must have been obtained usingborrowObject
or a related method as defined in an implementation or sub-interface using akey
that is equivalent to the one used to borrow theObject
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.
- Specified by:
invalidateObject
in interfaceKeyedObjectPool<K,V>
- Parameters:
key
- the key used to obtain the objectobj
- aborrowed
instance to be returned.
-
addObject
public void addObject(K key) throws java.lang.Exception, java.lang.IllegalStateException, java.lang.UnsupportedOperationException
Create an object using thefactory
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).- Specified by:
addObject
in interfaceKeyedObjectPool<K,V>
- Parameters:
key
- the key a new instance should be added to- Throws:
java.lang.Exception
- whenKeyedPooledObjectFactory.makeObject(K)
fails.java.lang.IllegalStateException
- afterKeyedObjectPool.close()
has been called on this pool.java.lang.UnsupportedOperationException
- when this pool cannot add new idle objects.
-
getNumIdle
public int getNumIdle(K key)
Returns the number of instances corresponding to the givenkey
currently idle in this pool. Returns a negative value if this information is not available.- Specified by:
getNumIdle
in interfaceKeyedObjectPool<K,V>
- Parameters:
key
- the key to query- Returns:
- the number of instances corresponding to the given
key
currently idle in this pool.
-
getNumActive
public int getNumActive(K key)
Returns the number of instances currently borrowed from but not yet returned to the pool corresponding to the givenkey
. Returns a negative value if this information is not available.- Specified by:
getNumActive
in interfaceKeyedObjectPool<K,V>
- Parameters:
key
- the key to query- Returns:
- the number of instances currently borrowed from but not yet
returned to the pool corresponding to the given
key
. =
-
getNumIdle
public int getNumIdle()
Returns the total number of instances currently idle in this pool. Returns a negative value if this information is not available.- Specified by:
getNumIdle
in interfaceKeyedObjectPool<K,V>
- Returns:
- the total number of instances currently idle in this pool. =
-
getNumActive
public int getNumActive()
Returns the total number of instances current borrowed from this pool but not yet returned. Returns a negative value if this information is not available.- Specified by:
getNumActive
in interfaceKeyedObjectPool<K,V>
- Returns:
- the total number of instances current borrowed from this pool but not yet returned.
-
clear
public void clear() throws java.lang.Exception, java.lang.UnsupportedOperationException
Clears the pool, removing all pooled instances (optional operation).- Specified by:
clear
in interfaceKeyedObjectPool<K,V>
- Throws:
java.lang.UnsupportedOperationException
- when this implementation doesn't support the operationjava.lang.Exception
- if the pool cannot be cleared
-
clear
public void clear(K key) throws java.lang.Exception, java.lang.UnsupportedOperationException
Clears the specified pool, removing all pooled instances corresponding to the givenkey
(optional operation).- Specified by:
clear
in interfaceKeyedObjectPool<K,V>
- Parameters:
key
- the key to clear- Throws:
java.lang.UnsupportedOperationException
- when this implementation doesn't support the operationjava.lang.Exception
- if the key cannot be cleared
-
close
public void close()
Close this pool, and free any resources associated with it.Calling
addObject
orborrowObject
after invoking this method on a pool will cause them to throw anIllegalStateException
.Implementations should silently fail if not all resources can be freed.
- Specified by:
close
in interfaceKeyedObjectPool<K,V>
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-