Class PoolUtils.SynchronizedKeyedObjectPool<K,V>
- All Implemented Interfaces:
KeyedObjectPool<K,
V>
- Enclosing class:
PoolUtils
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 -
Constructor Summary
ConstructorsConstructorDescriptionSynchronizedKeyedObjectPool
(KeyedObjectPool<K, V> keyedPool) Create a new SynchronizedKeyedObjectPool wrapping the given pool -
Method Summary
Modifier and TypeMethodDescriptionvoid
Create an object using thefactory
or other implementation dependent mechanism, passivate it, and then place it in the idle object pool.borrowObject
(K key) Obtains an instance from this pool for the specifiedkey
.void
clear()
Clears the pool, removing all pooled instances (optional operation).void
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
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 givenkey
(optional operation).int
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 givenkey
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.0toString()
-
Field Details
-
lock
Object whose monitor is used to synchronize methods on the wrapped pool. -
keyedPool
Underlying object pool
-
-
Constructor Details
-
SynchronizedKeyedObjectPool
SynchronizedKeyedObjectPool(KeyedObjectPool<K, V> keyedPool) throws IllegalArgumentExceptionCreate a new SynchronizedKeyedObjectPool wrapping the given pool- Parameters:
keyedPool
- KeyedObjectPool to wrap- Throws:
IllegalArgumentException
- if keyedPool is null
-
-
Method Details
-
borrowObject
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 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). Older versions of this method would return
null
to indicate exhaustion, newer versions are encouraged to throw aNoSuchElementException
.- Specified by:
borrowObject
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the key used to obtain the object- Returns:
- an instance from this pool.
- Throws:
Exception
- whenmakeObject
throws an exceptionNoSuchElementException
- when the pool is exhausted and cannot or will not return another instanceIllegalStateException
- afterclose
has been called on this pool
-
returnObject
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
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
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:
Exception
- whenKeyedPoolableObjectFactory.makeObject(K)
fails.IllegalStateException
- afterKeyedObjectPool.close()
has been called on this pool.UnsupportedOperationException
- when this pool cannot add new idle objects.
-
getNumIdle
Returns the number of instances corresponding to the givenkey
currently idle in this pool (optional operation). 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 or a negative value if unsupported - Throws:
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operation
-
getNumActive
Returns the number of instances currently borrowed from but not yet returned to the pool corresponding to the givenkey
(optional operation). 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 corresponding to the given
key
currently borrowed in this pool or a negative value if unsupported - Throws:
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operation
-
getNumIdle
Returns the total number of instances currently idle in this pool (optional operation). 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 or a negative value if unsupported
- Throws:
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operation
-
getNumActive
Returns the total number of instances current borrowed from this pool but not yet returned (optional operation). Returns a negative value if this information is not available.- Specified by:
getNumActive
in interfaceKeyedObjectPool<K,
V> - Returns:
- the total number of instances currently borrowed from this pool or a negative value if unsupported
- Throws:
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operation
-
clear
Clears the pool, removing all pooled instances (optional operation). ThrowsUnsupportedOperationException
if the pool cannot be cleared.- Specified by:
clear
in interfaceKeyedObjectPool<K,
V> - Throws:
UnsupportedOperationException
- when this implementation doesn't support the operationException
-
clear
Clears the specified pool, removing all pooled instances corresponding to the givenkey
(optional operation). ThrowsUnsupportedOperationException
if the pool cannot be cleared.- Specified by:
clear
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the key to clear- Throws:
UnsupportedOperationException
- when this implementation doesn't support the operationException
-
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
.- Specified by:
close
in interfaceKeyedObjectPool<K,
V>
-
setFactory
@Deprecated public void setFactory(KeyedPoolableObjectFactory<K, V> factory) throws IllegalStateException, UnsupportedOperationExceptionDeprecated.to be removed in pool 2.0Sets the object factory used by the pool.- Specified by:
setFactory
in interfaceKeyedObjectPool<K,
V> - Parameters:
factory
- KeyedPoolableObjectFactory used by the pool- Throws:
IllegalStateException
- when the factory cannot be set at this timeUnsupportedOperationException
- when this implementation doesn't support the operation
-
toString
-