Package org.apache.tomcat.dbcp.pool2
Class BaseKeyedPooledObjectFactory<K,V> 
java.lang.Object
org.apache.tomcat.dbcp.pool2.BaseObject
org.apache.tomcat.dbcp.pool2.BaseKeyedPooledObjectFactory<K,V> 
- Type Parameters:
- K- The type of keys managed by this factory.
- V- Type of element managed by this factory.
- All Implemented Interfaces:
- KeyedPooledObjectFactory<K,- V> 
public abstract class BaseKeyedPooledObjectFactory<K,V> 
extends BaseObject
implements KeyedPooledObjectFactory<K,V> 
A base implementation of 
KeyedPooledObjectFactory.
 All operations defined here are essentially no-op's.
This class is immutable, and therefore thread-safe.
- Since:
- 2.0
- See Also:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidactivateObject(K key, PooledObject<V> p) Reinitialize an instance to be returned by the pool.abstract VCreate an instance that can be served by the pool.voiddestroyObject(K key, PooledObject<V> p) Destroy an instance no longer needed by the pool.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.abstract PooledObject<V>Wrap the provided instance with an implementation ofPooledObject.Methods inherited from class org.apache.tomcat.dbcp.pool2.BaseObjecttoString, toStringAppendFieldsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.tomcat.dbcp.pool2.KeyedPooledObjectFactorydestroyObject
- 
Constructor Details- 
BaseKeyedPooledObjectFactorypublic BaseKeyedPooledObjectFactory()
 
- 
- 
Method Details- 
createCreate an instance that can be served by the pool.- Parameters:
- key- the key used when constructing the object
- Returns:
- an instance that can be served by the pool
- Throws:
- Exception- if there is a problem creating a new instance, this will be propagated to the code requesting an object.
 
- 
wrapWrap the provided instance with an implementation ofPooledObject.- Parameters:
- value- the instance to wrap
- Returns:
- The provided instance, wrapped by a PooledObject
 
- 
makeObjectDescription copied from interface:KeyedPooledObjectFactoryCreate an instance that can be served by the pool and wrap it in aPooledObjectto be managed by the pool.- Specified by:
- makeObjectin interface- KeyedPooledObjectFactory<K,- V> 
- Parameters:
- key- the key used when constructing the object
- Returns:
- a PooledObjectwrapping an instance that can be served by the pool.
- Throws:
- Exception- if there is a problem creating a new instance, this will be propagated to the code requesting an object.
 
- 
destroyObjectDestroy an instance no longer needed by the pool.The default implementation is a no-op. - Specified by:
- destroyObjectin interface- KeyedPooledObjectFactory<K,- V> 
- Parameters:
- key- the key used when selecting the instance
- p- a- PooledObjectwrapping the instance to be destroyed
- Throws:
- Exception- should be avoided as it may be swallowed by the pool implementation.
- See Also:
 
- 
validateObjectEnsures that the instance is safe to be returned by the pool.The default implementation always returns true.- Specified by:
- validateObjectin interface- KeyedPooledObjectFactory<K,- V> 
- Parameters:
- key- the key used when selecting the object
- p- a- PooledObjectwrapping the instance to be validated
- Returns:
- always truein the default implementation
 
- 
activateObjectReinitialize an instance to be returned by the pool.The default implementation is a no-op. - Specified by:
- activateObjectin interface- KeyedPooledObjectFactory<K,- V> 
- Parameters:
- key- the key used when selecting the object
- p- a- PooledObjectwrapping the instance to be activated
- Throws:
- Exception- if there is a problem activating- obj, this exception may be swallowed by the pool.
- See Also:
 
- 
passivateObjectUninitialize an instance to be returned to the idle object pool.The default implementation is a no-op. - Specified by:
- passivateObjectin interface- KeyedPooledObjectFactory<K,- V> 
- Parameters:
- key- the key used when selecting the object
- p- a- PooledObjectwrapping the instance to be passivated
- Throws:
- Exception- if there is a problem passivating- obj, this exception may be swallowed by the pool.
- See Also:
 
 
-