Package org.apache.tomcat.dbcp.pool2
Interface KeyedPooledObjectFactory<K,V>
- 
- Type Parameters:
- K- The type of keys managed by this factory.
- V- Type of element managed by this factory.
 - All Known Implementing Classes:
- BaseKeyedPooledObjectFactory,- PoolingConnection
 
 public interface KeyedPooledObjectFactory<K,V>An interface defining life-cycle methods for instances to be served by aKeyedObjectPool.By contract, when an KeyedObjectPooldelegates to aKeyedPooledObjectFactory,- 
   makeObject(K)is called whenever a new instance is needed.
- 
   activateObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>)is invoked on every instance that has beenpassivatedbefore it isborrowedfrom the pool.
- 
   validateObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>)may be invoked onactivatedinstances to make sure they can beborrowedfrom the pool.validateObjectmay also be used to test an instance beingreturnedto the pool before it ispassivated. It will only be invoked on an activated instance.
- 
   passivateObjectis invoked on every instance when it is returned to the pool.
- 
   destroyObjectis invoked on every instance when it is being "dropped" from the pool (whether due to the response fromvalidateObject, or for reasons specific to the pool implementation.) There is no guarantee that the instance being destroyed will be considered active, passive or in a generally consistent state.
 KeyedPooledObjectFactorymust be thread-safe. The only promise anKeyedObjectPoolmakes is that the same instance of an object will not be passed to more than one method of aKeyedPoolableObjectFactoryat a time.While clients of a KeyedObjectPoolborrow and return instances of the underlying value type V, the factory methods act on instances ofPooledObject<V>. These are the object wrappers that pools use to track and maintain state informations about the objects that they manage.- Since:
- 2.0
- See Also:
- KeyedObjectPool,- BaseKeyedPooledObjectFactory
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidactivateObject(K key, PooledObject<V> p)Reinitialize an instance to be returned by the pool.voiddestroyObject(K key, PooledObject<V> p)Destroy an instance no longer needed by the pool.voiddestroyObject(K key, PooledObject<V> p, DestroyMode mode)Destroy an instance no longer needed by the pool, using the providedDestroyMode.PooledObject<V>makeObject(K key)Create an instance that can be served by the pool and wrap it in aPooledObjectto be managed by the pool.voidpassivateObject(K key, PooledObject<V> p)Uninitialize an instance to be returned to the idle object pool.booleanvalidateObject(K key, PooledObject<V> p)Ensures that the instance is safe to be returned by the pool.
 
- 
- 
- 
Method Detail- 
makeObjectPooledObject<V> makeObject(K key) throws java.lang.Exception Create an instance that can be served by the pool and wrap it in aPooledObjectto be managed by the pool.- Parameters:
- key- the key used when constructing the object
- Returns:
- a PooledObjectwrapping an instance that can be served by the pool.
- Throws:
- java.lang.Exception- if there is a problem creating a new instance, this will be propagated to the code requesting an object.
 
 - 
destroyObjectvoid destroyObject(K key, PooledObject<V> p) throws java.lang.Exception Destroy an instance no longer needed by the pool.It is important for implementations of this method to be aware that there is no guarantee about what state objwill be in and the implementation should be prepared to handle unexpected errors.Also, an implementation must take in to consideration that instances lost to the garbage collector may never be destroyed. - Parameters:
- key- the key used when selecting the instance
- p- a- PooledObjectwrapping the instance to be destroyed
- Throws:
- java.lang.Exception- should be avoided as it may be swallowed by the pool implementation.
- See Also:
- validateObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>),- KeyedObjectPool.invalidateObject(K, V)
 
 - 
destroyObjectvoid destroyObject(K key, PooledObject<V> p, DestroyMode mode) throws java.lang.Exception Destroy an instance no longer needed by the pool, using the providedDestroyMode.- Parameters:
- key- the key used when selecting the instance
- p- a- PooledObjectwrapping the instance to be destroyed
- mode- DestroyMode providing context to the factory
- Throws:
- java.lang.Exception- should be avoided as it may be swallowed by the pool implementation.
- Since:
- 2.9.0
- See Also:
- validateObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>),- KeyedObjectPool.invalidateObject(K, V),- destroyObject(Object, PooledObject),- DestroyMode
 
 - 
validateObjectboolean validateObject(K key, PooledObject<V> p) Ensures that the instance is safe to be returned by the pool.- Parameters:
- key- the key used when selecting the object
- p- a- PooledObjectwrapping the instance to be validated
- Returns:
- falseif- objis not valid and should be dropped from the pool,- trueotherwise.
 
 - 
activateObjectvoid activateObject(K key, PooledObject<V> p) throws java.lang.Exception Reinitialize an instance to be returned by the pool.- Parameters:
- key- the key used when selecting the object
- p- a- PooledObjectwrapping the instance to be activated
- Throws:
- java.lang.Exception- if there is a problem activating- obj, this exception may be swallowed by the pool.
- See Also:
- destroyObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>)
 
 - 
passivateObjectvoid passivateObject(K key, PooledObject<V> p) throws java.lang.Exception Uninitialize an instance to be returned to the idle object pool.- Parameters:
- key- the key used when selecting the object
- p- a- PooledObjectwrapping the instance to be passivated
- Throws:
- java.lang.Exception- if there is a problem passivating- obj, this exception may be swallowed by the pool.
- See Also:
- destroyObject(K, org.apache.tomcat.dbcp.pool2.PooledObject<V>)
 
 
- 
 
-