Interface KeyedObjectPool<K,V>
-
- Type Parameters:
K- The type of keys maintained by this pool.V- Type of element pooled in this pool.
- All Superinterfaces:
java.lang.AutoCloseable,java.io.Closeable
- All Known Implementing Classes:
GenericKeyedObjectPool
public interface KeyedObjectPool<K,V> extends java.io.CloseableA "keyed" pooling interface.A keyed pool maintains a pool of instances for each key value.
Example of use:
Object obj =
null; Object key ="Key";try{ obj = pool.borrowObject(key);//...use the object...}catch(Exception e) {// invalidate the objectpool.invalidateObject(key, obj);// do not return the object to the pool twiceobj =null; }finally{// make sure the object is returned to the poolif(null!= obj) { pool.returnObject(key, obj); } }KeyedObjectPoolimplementations may choose to store at most one instance per key value, or may choose to maintain a pool of instances for each key (essentially creating aMapofpools).See
GenericKeyedObjectPoolfor an implementation.- Since:
- 2.0
- See Also:
KeyedPooledObjectFactory,ObjectPool,GenericKeyedObjectPool
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description voidaddObject(K key)Creates an object using thefactoryor other implementation dependent mechanism, passivate it, and then place it in the idle object pool.default voidaddObjects(java.util.Collection<K> keys, int count)default voidaddObjects(K key, int count)VborrowObject(K key)Borrows an instance from this pool for the specifiedkey.voidclear()Clears the pool, removing all pooled instances (optional operation).voidclear(K key)Clears the specified pool, removing all pooled instances corresponding to the givenkey(optional operation).voidclose()Closes this pool, and free any resources associated with it.default java.util.List<K>getKeys()Gets a copy of the pool key list.intgetNumActive()Gets the total number of instances currently borrowed from this pool but not yet returned.intgetNumActive(K key)Gets the number of instances currently borrowed from but not yet returned to the pool corresponding to the givenkey.intgetNumIdle()Gets the total number of instances currently idle in this pool.intgetNumIdle(K key)Gets the number of instances corresponding to the givenkeycurrently idle in this pool.voidinvalidateObject(K key, V obj)Invalidates an object from the pool.default voidinvalidateObject(K key, V obj, DestroyMode destroyMode)Invalidates an object from the pool, using the providedDestroyMode.voidreturnObject(K key, V obj)Return an instance to the pool.
-
-
-
Method Detail
-
addObject
void addObject(K key) throws java.lang.Exception
Creates an object using thefactoryor other implementation dependent mechanism, passivate it, and then place it in the idle object pool.addObjectis useful for "pre-loading" a pool with idle objects (Optional operation).- Parameters:
key- the key a new instance should be added to- Throws:
java.lang.Exception- whenKeyedPooledObjectFactory.makeObject(K)fails.java.lang.IllegalStateException- afterclose()has been called on this pool.java.lang.UnsupportedOperationException- when this pool cannot add new idle objects.
-
addObjects
default void addObjects(java.util.Collection<K> keys, int count) throws java.lang.Exception
CallsaddObject(Object)with each key inkeysforcountnumber of times. This has the same effect as callingaddObjects(Object, int)for each key in thekeyscollection.- Parameters:
keys-Collectionof keys to add objects for.count- the number of idle objects to add for eachkey.- Throws:
java.lang.Exception- whenaddObject(Object)fails.java.lang.IllegalArgumentException- whenkeyedPool,keys, or any value inkeysisnull.- See Also:
addObjects(Object, int)
-
addObjects
default void addObjects(K key, int count) throws java.lang.Exception
- Parameters:
key- the key to add objects for.count- the number of idle objects to add forkey.- Throws:
java.lang.Exception- whenaddObject(Object)fails.java.lang.IllegalArgumentException- whenkeyisnull.- Since:
- 2.8.0
-
borrowObject
V borrowObject(K key) throws java.lang.Exception
Borrows an instance from this pool for the specifiedkey.Instances returned from this method will have been either newly created with
makeObjector will be a previously idle object and have been activated withactivateObjectand 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 akeythat isequivalentto the one used to borrow the instance in the first place.The behavior of this method when the pool has been exhausted is not strictly specified (although it may be specified by implementations).
- Parameters:
key- the key used to obtain the object- Returns:
- an instance from this pool.
- Throws:
java.lang.IllegalStateException- afterclosehas been called on this pooljava.lang.Exception- whenmakeObjectthrows an exceptionjava.util.NoSuchElementException- when the pool is exhausted and cannot or will not return another instance
-
clear
void clear() throws java.lang.ExceptionClears the pool, removing all pooled instances (optional operation).- Throws:
java.lang.UnsupportedOperationException- when this implementation doesn't support the operationjava.lang.Exception- if the pool cannot be cleared
-
clear
void clear(K key) throws java.lang.Exception
Clears the specified pool, removing all pooled instances corresponding to the givenkey(optional operation).- 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
void close()
Closes this pool, and free any resources associated with it.Calling
addObjectorborrowObjectafter 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:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable
-
getKeys
default java.util.List<K> getKeys()
Gets a copy of the pool key list.Note: The default implementation returns an empty list. Implementations should override this method.
- Returns:
- a copy of the pool key list.
- Since:
- 2.12.0
-
getNumActive
int getNumActive()
Gets the total number of instances currently borrowed from this pool but not yet returned. Returns a negative value if this information is not available.- Returns:
- the total number of instances currently borrowed from this pool but not yet returned.
-
getNumActive
int getNumActive(K key)
Gets 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.- 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
int getNumIdle()
Gets the total number of instances currently idle in this pool. Returns a negative value if this information is not available.- Returns:
- the total number of instances currently idle in this pool.
-
getNumIdle
int getNumIdle(K key)
Gets the number of instances corresponding to the givenkeycurrently idle in this pool. Returns a negative value if this information is not available.- Parameters:
key- the key to query- Returns:
- the number of instances corresponding to the given
keycurrently idle in this pool.
-
invalidateObject
void invalidateObject(K key, V obj) throws java.lang.Exception
Invalidates an object from the pool.By contract,
objmust have been obtained usingborrowObjector a related method as defined in an implementation or sub-interface using akeythat is equivalent to the one used to borrow theObjectin 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.
- Parameters:
key- the key used to obtain the objectobj- aborrowedinstance to be returned.- Throws:
java.lang.Exception- if the instance cannot be invalidated
-
invalidateObject
default void invalidateObject(K key, V obj, DestroyMode destroyMode) throws java.lang.Exception
Invalidates an object from the pool, using the providedDestroyMode.By contract,
objmust have been obtained usingborrowObjector a related method as defined in an implementation or sub-interface using akeythat is equivalent to the one used to borrow theObjectin 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.
- Parameters:
key- the key used to obtain the objectobj- aborrowedinstance to be returned.destroyMode- destroy activation context provided to the factory- Throws:
java.lang.Exception- if the instance cannot be invalidated- Since:
- 2.9.0
-
returnObject
void returnObject(K key, V obj) throws java.lang.Exception
Return an instance to the pool. By contract,objmust have been obtained usingborrowObjector a related method as defined in an implementation or sub-interface using akeythat is equivalent to the one used to borrow the instance in the first place.- Parameters:
key- the key used to obtain the objectobj- aborrowedinstance to be returned.- Throws:
java.lang.IllegalStateException- if an attempt is made to return an object to the pool that is in any state other than allocated (i.e. borrowed). Attempting to return an object more than once or attempting to return an object that was never borrowed from the pool will trigger this exception.java.lang.Exception- if an instance cannot be returned to the pool
-
-