Class ProxiedKeyedObjectPool<K,V>
- Type Parameters:
K- type of the keyV- type of the pooled object
- All Implemented Interfaces:
Closeable,AutoCloseable,KeyedObjectPool<K,V>
- Since:
- 2.0
-
Constructor Summary
ConstructorsConstructorDescriptionProxiedKeyedObjectPool(KeyedObjectPool<K, V> pool, org.apache.commons.pool2.proxy.ProxySource<V> proxySource) Constructs a new proxied object pool. -
Method Summary
Modifier and TypeMethodDescriptionvoidCreates an object using thefactoryor other implementation dependent mechanism, passivate it, and then place it in the idle object pool.borrowObject(K key) Borrows an instance from this pool for the specifiedkey.voidclear()Clears the pool, removing all pooled instances (optional operation).voidClears the specified pool, removing all pooled instances corresponding to the givenkey(optional operation).voidclose()Closes this pool, and free any resources associated with it.getKeys()Gets a copy of the pool key list.intGets 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.intGets 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 proxy) Invalidates an object from the pool.voidreturnObject(K key, V proxy) Return an instance to the pool.toString()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.pool2.KeyedObjectPool
addObjects, addObjects, invalidateObject
-
Constructor Details
-
ProxiedKeyedObjectPool
public ProxiedKeyedObjectPool(KeyedObjectPool<K, V> pool, org.apache.commons.pool2.proxy.ProxySource<V> proxySource) Constructs a new proxied object pool.- Parameters:
pool- The object pool to wrapproxySource- The source of the proxy objects
-
-
Method Details
-
addObject
Description copied from interface:KeyedObjectPoolCreates 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).- Specified by:
addObjectin interfaceKeyedObjectPool<K,V> - Parameters:
key- the key a new instance should be added to- Throws:
Exception- whenKeyedPooledObjectFactory.makeObject(K)fails.
-
borrowObject
Description copied from interface:KeyedObjectPoolBorrows 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).
- Specified by:
borrowObjectin interfaceKeyedObjectPool<K,V> - Parameters:
key- the key used to obtain the object- Returns:
- an instance from this pool.
- Throws:
Exception- whenmakeObjectthrows an exception
-
clear
Description copied from interface:KeyedObjectPoolClears the pool, removing all pooled instances (optional operation).- Specified by:
clearin interfaceKeyedObjectPool<K,V> - Throws:
Exception- if the pool cannot be cleared
-
clear
Description copied from interface:KeyedObjectPoolClears the specified pool, removing all pooled instances corresponding to the givenkey(optional operation).- Specified by:
clearin interfaceKeyedObjectPool<K,V> - Parameters:
key- the key to clear- Throws:
Exception- if the key cannot be cleared
-
close
Description copied from interface:KeyedObjectPoolCloses 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 interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceKeyedObjectPool<K,V>
-
getKeys
Gets a copy of the pool key list.- Specified by:
getKeysin interfaceKeyedObjectPool<K,V> - Returns:
- a copy of the pool key list.
- Since:
- 2.12.0
-
getNumActive
Description copied from interface:KeyedObjectPoolGets the total number of instances currently borrowed from this pool but not yet returned. Returns a negative value if this information is not available.- Specified by:
getNumActivein interfaceKeyedObjectPool<K,V> - Returns:
- the total number of instances currently borrowed from this pool but not yet returned.
-
getNumActive
Description copied from interface:KeyedObjectPoolGets 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:
getNumActivein 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
Description copied from interface:KeyedObjectPoolGets the total number of instances currently idle in this pool. Returns a negative value if this information is not available.- Specified by:
getNumIdlein interfaceKeyedObjectPool<K,V> - Returns:
- the total number of instances currently idle in this pool.
-
getNumIdle
Description copied from interface:KeyedObjectPoolGets the number of instances corresponding to the givenkeycurrently idle in this pool. Returns a negative value if this information is not available.- Specified by:
getNumIdlein interfaceKeyedObjectPool<K,V> - Parameters:
key- the key to query- Returns:
- the number of instances corresponding to the given
keycurrently idle in this pool.
-
invalidateObject
Description copied from interface:KeyedObjectPoolInvalidates 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.
- Specified by:
invalidateObjectin interfaceKeyedObjectPool<K,V> - Parameters:
key- the key used to obtain the objectproxy- aborrowedinstance to be returned.- Throws:
Exception- if the instance cannot be invalidated
-
returnObject
Description copied from interface:KeyedObjectPoolReturn 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.- Specified by:
returnObjectin interfaceKeyedObjectPool<K,V> - Parameters:
key- the key used to obtain the objectproxy- aborrowedinstance to be returned.- Throws:
Exception- if an instance cannot be returned to the pool
-
toString
-