Class GenericKeyedObjectPool<K,T>
- java.lang.Object
- 
- org.apache.tomcat.dbcp.pool2.BaseObject
- 
- org.apache.tomcat.dbcp.pool2.impl.BaseGenericObjectPool<T>
- 
- org.apache.tomcat.dbcp.pool2.impl.GenericKeyedObjectPool<K,T>
 
 
 
- 
- Type Parameters:
- K- The type of keys maintained by this pool.
- T- Type of element pooled in this pool.
 - All Implemented Interfaces:
- java.io.Closeable,- java.lang.AutoCloseable,- GenericKeyedObjectPoolMXBean<K>,- KeyedObjectPool<K,T>,- UsageTracking<T>
 
 public class GenericKeyedObjectPool<K,T> extends BaseGenericObjectPool<T> implements KeyedObjectPool<K,T>, GenericKeyedObjectPoolMXBean<K>, UsageTracking<T> A configurableKeyedObjectPoolimplementation.When coupled with the appropriate KeyedPooledObjectFactory,GenericKeyedObjectPoolprovides robust pooling functionality for keyed objects. AGenericKeyedObjectPoolcan be viewed as a map of sub-pools, keyed on the (unique) key values provided to thepreparePool,addObjectorborrowObjectmethods. Each time a new key value is provided to one of these methods, a sub-new pool is created under the given key to be managed by the containingGenericKeyedObjectPool.Note that the current implementation uses a ConcurrentHashMap which uses equals() to compare keys. This means that distinct instance keys must be distinguishable using equals. Optionally, one may configure the pool to examine and possibly evict objects as they sit idle in the pool and to ensure that a minimum number of idle objects is maintained for each key. This is performed by an "idle object eviction" thread, which runs asynchronously. Caution should be used when configuring this optional feature. Eviction runs contend with client threads for access to objects in the pool, so if they run too frequently performance issues may result. Implementation note: To prevent possible deadlocks, care has been taken to ensure that no call to a factory method will occur within a synchronization block. See POOL-125 and DBCP-44 for more information. This class is intended to be thread-safe. - Since:
- 2.0
- See Also:
- GenericObjectPool
 
- 
- 
Field Summary- 
Fields inherited from class org.apache.tomcat.dbcp.pool2.impl.BaseGenericObjectPoolabandonedConfig, MEAN_TIMING_STATS_CACHE_SIZE
 
- 
 - 
Constructor SummaryConstructors Constructor Description GenericKeyedObjectPool(KeyedPooledObjectFactory<K,T> factory)Constructs a newGenericKeyedObjectPoolusing defaults fromGenericKeyedObjectPoolConfig.GenericKeyedObjectPool(KeyedPooledObjectFactory<K,T> factory, GenericKeyedObjectPoolConfig<T> config)Constructs a newGenericKeyedObjectPoolusing a specific configuration.GenericKeyedObjectPool(KeyedPooledObjectFactory<K,T> factory, GenericKeyedObjectPoolConfig<T> config, AbandonedConfig abandonedConfig)Creates a newGenericKeyedObjectPoolthat tracks and destroys objects that are checked out, but never returned to the pool.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddObject(K key)Create an object using thefactory, passivate it, and then place it in the idle object pool.TborrowObject(K key)Equivalent toborrowObject(key,BaseGenericObjectPool.getMaxWaitDuration())TborrowObject(K key, long borrowMaxWaitMillis)Borrows an object from the sub-pool associated with the given key using the specified waiting time which only applies ifBaseGenericObjectPool.getBlockWhenExhausted()is true.voidclear()Clears any objects sitting idle in the pool by removing them from the idle instance sub-pools and then invoking the configured PoolableObjectFactory'sKeyedPooledObjectFactory.destroyObject(Object, PooledObject)method on each idle instance.voidclear(K key)Clears the specified sub-pool, removing all pooled instances corresponding to the givenkey.voidclearOldest()Clears oldest 15% of objects in pool.voidclose()Closes the keyed object pool.voidevict()PerformnumTestsidle object eviction tests, evicting examined objects that meet the criteria for eviction.KeyedPooledObjectFactory<K,T>getFactory()Gets a reference to the factory used to create, destroy and validate the objects used by this pool.intgetMaxIdlePerKey()Gets the cap on the number of "idle" instances per key in the pool.intgetMaxTotalPerKey()Gets the limit on the number of object instances allocated by the pool (checked out or idle), per key.intgetMinIdlePerKey()Gets the target for the minimum number of idle objects to maintain in each of the keyed sub-pools.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.java.util.Map<java.lang.String,java.lang.Integer>getNumActivePerKey()intgetNumIdle()The number of instances currently idle in this pool.intgetNumIdle(K key)Gets the number of instances corresponding to the givenkeycurrently idle in this pool.intgetNumWaiters()Return an estimate of the number of threads currently blocked waiting for an object from the pool.java.util.Map<java.lang.String,java.lang.Integer>getNumWaitersByKey()Return an estimate of the number of threads currently blocked waiting for an object from the pool for each key.voidinvalidateObject(K key, T obj)Invalidates an object from the pool.voidinvalidateObject(K key, T obj, DestroyMode destroyMode)Invalidates an object from the pool, using the providedDestroyMode.java.util.Map<java.lang.String,java.util.List<DefaultPooledObjectInfo>>listAllObjects()Provides information on all the objects in the pool, both idle (waiting to be borrowed) and active (currently borrowed).voidpreparePool(K key)Registers a key for pool control and ensures thatgetMinIdlePerKey()idle instances are created.voidreturnObject(K key, T obj)Returns an object to a keyed sub-pool.voidsetConfig(GenericKeyedObjectPoolConfig<T> conf)Sets the configuration.voidsetMaxIdlePerKey(int maxIdlePerKey)Sets the cap on the number of "idle" instances per key in the pool.voidsetMaxTotalPerKey(int maxTotalPerKey)Sets the limit on the number of object instances allocated by the pool (checked out or idle), per key.voidsetMinIdlePerKey(int minIdlePerKey)Sets the target for the minimum number of idle objects to maintain in each of the keyed sub-pools.protected voidtoStringAppendFields(java.lang.StringBuilder builder)Used by sub-classes to include the fields defined by the sub-class in theBaseObject.toString()output.voiduse(T pooledObject)Called every time a pooled object is used to enable the pool to better track borrowed objects.- 
Methods inherited from class org.apache.tomcat.dbcp.pool2.impl.BaseGenericObjectPoolgetBlockWhenExhausted, getBorrowedCount, getCreatedCount, getCreationStackTrace, getDestroyedByBorrowValidationCount, getDestroyedByEvictorCount, getDestroyedCount, getDurationBetweenEvictionRuns, getEvictionPolicy, getEvictionPolicyClassName, getEvictorShutdownTimeout, getEvictorShutdownTimeoutDuration, getEvictorShutdownTimeoutMillis, getFairness, getJmxName, getLifo, getLogAbandoned, getMaxBorrowWaitTimeMillis, getMaxTotal, getMaxWaitDuration, getMaxWaitMillis, getMeanActiveTimeMillis, getMeanBorrowWaitTimeMillis, getMeanIdleTimeMillis, getMessageStatistics, getMinEvictableIdleDuration, getMinEvictableIdleTime, getMinEvictableIdleTimeMillis, getNumTestsPerEvictionRun, getRemoveAbandonedOnBorrow, getRemoveAbandonedOnMaintenance, getRemoveAbandonedTimeout, getRemoveAbandonedTimeoutDuration, getReturnedCount, getSoftMinEvictableIdleDuration, getSoftMinEvictableIdleTime, getSoftMinEvictableIdleTimeMillis, getSwallowedExceptionListener, getTestOnBorrow, getTestOnCreate, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRuns, getTimeBetweenEvictionRunsMillis, isAbandonedConfig, isClosed, markReturningState, setAbandonedConfig, setBlockWhenExhausted, setConfig, setEvictionPolicy, setEvictionPolicyClassName, setEvictionPolicyClassName, setEvictorShutdownTimeout, setEvictorShutdownTimeoutMillis, setLifo, setMaxTotal, setMaxWait, setMaxWaitMillis, setMessagesStatistics, setMinEvictableIdle, setMinEvictableIdleTime, setMinEvictableIdleTimeMillis, setNumTestsPerEvictionRun, setSoftMinEvictableIdle, setSoftMinEvictableIdleTime, setSoftMinEvictableIdleTimeMillis, setSwallowedExceptionListener, setTestOnBorrow, setTestOnCreate, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRuns, setTimeBetweenEvictionRunsMillis
 - 
Methods inherited from class org.apache.tomcat.dbcp.pool2.BaseObjecttoString
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tomcat.dbcp.pool2.impl.GenericKeyedObjectPoolMXBeangetBlockWhenExhausted, getBorrowedCount, getCreatedCount, getCreationStackTrace, getDestroyedByBorrowValidationCount, getDestroyedByEvictorCount, getDestroyedCount, getFairness, getLifo, getLogAbandoned, getMaxBorrowWaitTimeMillis, getMaxTotal, getMaxWaitMillis, getMeanActiveTimeMillis, getMeanBorrowWaitTimeMillis, getMeanIdleTimeMillis, getMinEvictableIdleTimeMillis, getNumTestsPerEvictionRun, getRemoveAbandonedOnBorrow, getRemoveAbandonedOnMaintenance, getRemoveAbandonedTimeout, getReturnedCount, getTestOnBorrow, getTestOnCreate, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, isAbandonedConfig, isClosed
 - 
Methods inherited from interface org.apache.tomcat.dbcp.pool2.KeyedObjectPooladdObjects, addObjects
 
- 
 
- 
- 
- 
Constructor Detail- 
GenericKeyedObjectPoolpublic GenericKeyedObjectPool(KeyedPooledObjectFactory<K,T> factory) Constructs a newGenericKeyedObjectPoolusing defaults fromGenericKeyedObjectPoolConfig.- Parameters:
- factory- the factory to be used to create entries
 
 - 
GenericKeyedObjectPoolpublic GenericKeyedObjectPool(KeyedPooledObjectFactory<K,T> factory, GenericKeyedObjectPoolConfig<T> config) Constructs a newGenericKeyedObjectPoolusing a specific configuration.- Parameters:
- factory- the factory to be used to create entries
- config- The configuration to use for this pool instance. The configuration is used by value. Subsequent changes to the configuration object will not be reflected in the pool.
 
 - 
GenericKeyedObjectPoolpublic GenericKeyedObjectPool(KeyedPooledObjectFactory<K,T> factory, GenericKeyedObjectPoolConfig<T> config, AbandonedConfig abandonedConfig) Creates a newGenericKeyedObjectPoolthat tracks and destroys objects that are checked out, but never returned to the pool.- Parameters:
- factory- The object factory to be used to create object instances used by this pool
- config- The base pool configuration to use for this pool instance. The configuration is used by value. Subsequent changes to the configuration object will not be reflected in the pool.
- abandonedConfig- Configuration for abandoned object identification and removal. The configuration is used by value.
- Since:
- 2.10.0
 
 
- 
 - 
Method Detail- 
addObjectpublic void addObject(K key) throws java.lang.Exception Create an object using thefactory, passivate it, and then place it in the idle object pool.addObjectis useful for "pre-loading" a pool with idle objects.- Specified by:
- addObjectin interface- KeyedObjectPool<K,T>
- Parameters:
- key- the key a new instance should be added to
- Throws:
- java.lang.Exception- when- KeyedPooledObjectFactory.makeObject(K)fails.
 
 - 
borrowObjectpublic T borrowObject(K key) throws java.lang.Exception Equivalent toborrowObject(key,BaseGenericObjectPool.getMaxWaitDuration())key.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 interface- KeyedObjectPool<K,T>
- Parameters:
- key- the key used to obtain the object
- Returns:
- an instance from this pool.
- Throws:
- java.lang.IllegalStateException- after- closehas been called on this pool
- java.lang.Exception- when- makeObjectthrows an exception
- java.util.NoSuchElementException- when the pool is exhausted and cannot or will not return another instance
 
 - 
borrowObjectpublic T borrowObject(K key, long borrowMaxWaitMillis) throws java.lang.Exception Borrows an object from the sub-pool associated with the given key using the specified waiting time which only applies ifBaseGenericObjectPool.getBlockWhenExhausted()is true.If there is one or more idle instances available in the sub-pool associated with the given key, then an idle instance will be selected based on the value of BaseGenericObjectPool.getLifo(), activated and returned. If activation fails, ortestOnBorrowis set totrueand validation fails, the instance is destroyed and the next available instance is examined. This continues until either a valid instance is returned or there are no more idle instances available.If there are no idle instances available in the sub-pool associated with the given key, behavior depends on the maxTotalPerKey,maxTotal, and (if applicable)BaseGenericObjectPool.getBlockWhenExhausted()and the value passed in to theborrowMaxWaitMillisparameter. If the number of instances checked out from the sub-pool under the given key is less thanmaxTotalPerKeyand the total number of instances in circulation (under all keys) is less thanmaxTotal, a new instance is created, activated and (if applicable) validated and returned to the caller. If validation fails, aNoSuchElementExceptionwill be thrown.If the associated sub-pool is exhausted (no available idle instances and no capacity to create new ones), this method will either block ( BaseGenericObjectPool.getBlockWhenExhausted()is true) or throw aNoSuchElementException(BaseGenericObjectPool.getBlockWhenExhausted()is false). The length of time that this method will block whenBaseGenericObjectPool.getBlockWhenExhausted()is true is determined by the value passed in to theborrowMaxWaitparameter.When maxTotalis set to a positive value and this method is invoked when at the limit with no idle instances available under the requested key, an attempt is made to create room by clearing the oldest 15% of the elements from the keyed sub-pools.When the pool is exhausted, multiple calling threads may be simultaneously blocked waiting for instances to become available. A "fairness" algorithm has been implemented to ensure that threads receive available instances in request arrival order. - Parameters:
- key- pool key
- borrowMaxWaitMillis- The time to wait in milliseconds for an object to become available
- Returns:
- object instance from the keyed pool
- Throws:
- java.util.NoSuchElementException- if a keyed object instance cannot be returned because the pool is exhausted.
- java.lang.Exception- if a keyed object instance cannot be returned due to an error
 
 - 
clearpublic void clear() Clears any objects sitting idle in the pool by removing them from the idle instance sub-pools and then invoking the configured PoolableObjectFactory'sKeyedPooledObjectFactory.destroyObject(Object, PooledObject)method on each idle instance.Implementation notes: - This method does not destroy or effect in any way instances that are checked out when it is invoked.
- Invoking this method does not prevent objects being returned to the idle instance pool, even during its execution. Additional instances may be returned while removed items are being destroyed.
- Exceptions encountered destroying idle instances are swallowed
 but notified via a SwallowedExceptionListener.
 - Specified by:
- clearin interface- KeyedObjectPool<K,T>
 
 - 
clearpublic void clear(K key) Clears the specified sub-pool, removing all pooled instances corresponding to the givenkey. Exceptions encountered destroying idle instances are swallowed but notified via aSwallowedExceptionListener.- Specified by:
- clearin interface- KeyedObjectPool<K,T>
- Parameters:
- key- the key to clear
 
 - 
clearOldestpublic void clearOldest() Clears oldest 15% of objects in pool. The method sorts the objects into a TreeMap and then iterates the first 15% for removal.
 - 
closepublic void close() Closes the keyed object pool. Once the pool is closed,borrowObject(Object)will fail with IllegalStateException, butreturnObject(Object, Object)andinvalidateObject(Object, Object)will continue to work, with returned objects destroyed on return.Destroys idle instances in the pool by invoking clear().- Specified by:
- closein interface- java.lang.AutoCloseable
- Specified by:
- closein interface- java.io.Closeable
- Specified by:
- closein interface- KeyedObjectPool<K,T>
- Specified by:
- closein class- BaseGenericObjectPool<T>
 
 - 
evictpublic void evict() throws java.lang.ExceptionPerformnumTestsidle object eviction tests, evicting examined objects that meet the criteria for eviction. IftestWhileIdleis true, examined objects are validated when visited (and removed if invalid); otherwise only objects that have been idle for more thanminEvicableIdleTimeMillisare removed.Successive activations of this method examine objects in keyed sub-pools in sequence, cycling through the keys and examining objects in oldest-to-youngest order within the keyed sub-pools. - Specified by:
- evictin class- BaseGenericObjectPool<T>
- Throws:
- java.lang.Exception- when there is a problem evicting idle objects.
 
 - 
getFactorypublic KeyedPooledObjectFactory<K,T> getFactory() Gets a reference to the factory used to create, destroy and validate the objects used by this pool.- Returns:
- the factory
 
 - 
getMaxIdlePerKeypublic int getMaxIdlePerKey() Gets the cap on the number of "idle" instances per key in the pool. If maxIdlePerKey is set too low on heavily loaded systems it is possible you will see objects being destroyed and almost immediately new objects being created. This is a result of the active threads momentarily returning objects faster than they are requesting them, causing the number of idle objects to rise above maxIdlePerKey. The best value for maxIdlePerKey for heavily loaded system will vary but the default is a good starting point.- Specified by:
- getMaxIdlePerKeyin interface- GenericKeyedObjectPoolMXBean<K>
- Returns:
- the maximum number of "idle" instances that can be held in a given keyed sub-pool or a negative value if there is no limit
- See Also:
- setMaxIdlePerKey(int)
 
 - 
getMaxTotalPerKeypublic int getMaxTotalPerKey() Gets the limit on the number of object instances allocated by the pool (checked out or idle), per key. When the limit is reached, the sub-pool is said to be exhausted. A negative value indicates no limit.- Specified by:
- getMaxTotalPerKeyin interface- GenericKeyedObjectPoolMXBean<K>
- Returns:
- the limit on the number of active instances per key
- See Also:
- setMaxTotalPerKey(int)
 
 - 
getMinIdlePerKeypublic int getMinIdlePerKey() Gets the target for the minimum number of idle objects to maintain in each of the keyed sub-pools. This setting only has an effect if it is positive andBaseGenericObjectPool.getDurationBetweenEvictionRuns()is greater than zero. If this is the case, an attempt is made to ensure that each sub-pool has the required minimum number of instances during idle object eviction runs.If the configured value of minIdlePerKey is greater than the configured value for maxIdlePerKey then the value of maxIdlePerKey will be used instead. - Specified by:
- getMinIdlePerKeyin interface- GenericKeyedObjectPoolMXBean<K>
- Returns:
- minimum size of the each keyed pool
- See Also:
- BaseGenericObjectPool.setTimeBetweenEvictionRunsMillis(long)
 
 - 
getNumActivepublic int 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 interface- GenericKeyedObjectPoolMXBean<K>
- Specified by:
- getNumActivein interface- KeyedObjectPool<K,T>
- Returns:
- the total number of instances currently borrowed from this pool but not yet returned.
 
 - 
getNumActivepublic int getNumActive(K key) 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 interface- KeyedObjectPool<K,T>
- 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.
 
 - 
getNumActivePerKeypublic java.util.Map<java.lang.String,java.lang.Integer> getNumActivePerKey() Description copied from interface:GenericKeyedObjectPoolMXBean- Specified by:
- getNumActivePerKeyin interface- GenericKeyedObjectPoolMXBean<K>
- Returns:
- See getNumActivePerKey()
 
 - 
getNumIdlepublic int getNumIdle() Description copied from class:BaseGenericObjectPoolThe number of instances currently idle in this pool.- Specified by:
- getNumIdlein interface- GenericKeyedObjectPoolMXBean<K>
- Specified by:
- getNumIdlein interface- KeyedObjectPool<K,T>
- Specified by:
- getNumIdlein class- BaseGenericObjectPool<T>
- Returns:
- count of instances available for checkout from the pool
 
 - 
getNumIdlepublic int getNumIdle(K key) 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 interface- KeyedObjectPool<K,T>
- Parameters:
- key- the key to query
- Returns:
- the number of instances corresponding to the given
 keycurrently idle in this pool.
 
 - 
getNumWaiterspublic int getNumWaiters() Return an estimate of the number of threads currently blocked waiting for an object from the pool. This is intended for monitoring only, not for synchronization control.- Specified by:
- getNumWaitersin interface- GenericKeyedObjectPoolMXBean<K>
- Returns:
- The estimate of the number of threads currently blocked waiting for an object from the pool
 
 - 
getNumWaitersByKeypublic java.util.Map<java.lang.String,java.lang.Integer> getNumWaitersByKey() Return an estimate of the number of threads currently blocked waiting for an object from the pool for each key. This is intended for monitoring only, not for synchronization control.- Specified by:
- getNumWaitersByKeyin interface- GenericKeyedObjectPoolMXBean<K>
- Returns:
- The estimate of the number of threads currently blocked waiting for an object from the pool for each key
 
 - 
invalidateObjectpublic void invalidateObject(K key, T 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. Activation of this method decrements the active count associated with the given keyed pool and attempts to destroy obj.- Specified by:
- invalidateObjectin interface- KeyedObjectPool<K,T>
- Parameters:
- key- pool key
- obj- instance to invalidate
- Throws:
- java.lang.Exception- if an exception occurs destroying the object
- java.lang.IllegalStateException- if obj does not belong to the pool under the given key
 
 - 
invalidateObjectpublic void invalidateObject(K key, T 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. Activation of this method decrements the active count associated with the given keyed pool and attempts to destroy obj.- Specified by:
- invalidateObjectin interface- KeyedObjectPool<K,T>
- Parameters:
- key- pool key
- obj- instance to invalidate
- destroyMode- DestroyMode context provided to factory
- Throws:
- java.lang.Exception- if an exception occurs destroying the object
- java.lang.IllegalStateException- if obj does not belong to the pool under the given key
- Since:
- 2.9.0
 
 - 
listAllObjectspublic java.util.Map<java.lang.String,java.util.List<DefaultPooledObjectInfo>> listAllObjects() Provides information on all the objects in the pool, both idle (waiting to be borrowed) and active (currently borrowed).Note: This is named listAllObjects so it is presented as an operation via JMX. That means it won't be invoked unless the explicitly requested whereas all attributes will be automatically requested when viewing the attributes for an object in a tool like JConsole. - Specified by:
- listAllObjectsin interface- GenericKeyedObjectPoolMXBean<K>
- Returns:
- Information grouped by key on all the objects in the pool
 
 - 
preparePoolpublic void preparePool(K key) throws java.lang.Exception Registers a key for pool control and ensures thatgetMinIdlePerKey()idle instances are created.- Parameters:
- key- - The key to register for pool control.
- Throws:
- java.lang.Exception- If the associated factory throws an exception
 
 - 
returnObjectpublic void returnObject(K key, T obj) Returns an object to a keyed sub-pool.If maxIdleis set to a positive value and the number of idle instances under the given key has reached this value, the returning instance is destroyed.If testOnReturn== true, the returning instance is validated before being returned to the idle instance sub-pool under the given key. In this case, if validation fails, the instance is destroyed.Exceptions encountered destroying objects for any reason are swallowed but notified via a SwallowedExceptionListener.- Specified by:
- returnObjectin interface- KeyedObjectPool<K,T>
- Parameters:
- key- pool key
- obj- instance to return to the keyed pool
- Throws:
- java.lang.IllegalStateException- if an object is returned to the pool that was not borrowed from it or if an object is returned to the pool multiple times
 
 - 
setConfigpublic void setConfig(GenericKeyedObjectPoolConfig<T> conf) Sets the configuration.- Parameters:
- conf- the new configuration to use. This is used by value.
- See Also:
- GenericKeyedObjectPoolConfig
 
 - 
setMaxIdlePerKeypublic void setMaxIdlePerKey(int maxIdlePerKey) Sets the cap on the number of "idle" instances per key in the pool. If maxIdlePerKey is set too low on heavily loaded systems it is possible you will see objects being destroyed and almost immediately new objects being created. This is a result of the active threads momentarily returning objects faster than they are requesting them, causing the number of idle objects to rise above maxIdlePerKey. The best value for maxIdlePerKey for heavily loaded system will vary but the default is a good starting point.- Parameters:
- maxIdlePerKey- the maximum number of "idle" instances that can be held in a given keyed sub-pool. Use a negative value for no limit
- See Also:
- getMaxIdlePerKey()
 
 - 
setMaxTotalPerKeypublic void setMaxTotalPerKey(int maxTotalPerKey) Sets the limit on the number of object instances allocated by the pool (checked out or idle), per key. When the limit is reached, the sub-pool is said to be exhausted. A negative value indicates no limit.- Parameters:
- maxTotalPerKey- the limit on the number of active instances per key
- See Also:
- getMaxTotalPerKey()
 
 - 
setMinIdlePerKeypublic void setMinIdlePerKey(int minIdlePerKey) Sets the target for the minimum number of idle objects to maintain in each of the keyed sub-pools. This setting only has an effect if it is positive andBaseGenericObjectPool.getDurationBetweenEvictionRuns()is greater than zero. If this is the case, an attempt is made to ensure that each sub-pool has the required minimum number of instances during idle object eviction runs.If the configured value of minIdlePerKey is greater than the configured value for maxIdlePerKey then the value of maxIdlePerKey will be used instead. - Parameters:
- minIdlePerKey- The minimum size of the each keyed pool
- See Also:
- getMinIdlePerKey(),- getMaxIdlePerKey(),- BaseGenericObjectPool.setTimeBetweenEvictionRuns(Duration)
 
 - 
toStringAppendFieldsprotected void toStringAppendFields(java.lang.StringBuilder builder) Description copied from class:BaseObjectUsed by sub-classes to include the fields defined by the sub-class in theBaseObject.toString()output.- Overrides:
- toStringAppendFieldsin class- BaseGenericObjectPool<T>
- Parameters:
- builder- Field names and values are appended to this object
 
 - 
usepublic void use(T pooledObject) Description copied from interface:UsageTrackingCalled every time a pooled object is used to enable the pool to better track borrowed objects.- Specified by:
- usein interface- UsageTracking<K>
- Parameters:
- pooledObject- The object that is being used.
- Since:
- 2.10.0
 
 
- 
 
-