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 Summary
Constructors -
Method Summary
Modifier 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) Creates 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.BaseObject
toString, toStringAppendFieldsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.tomcat.dbcp.pool2.KeyedPooledObjectFactory
destroyObject
-
Constructor Details
-
BaseKeyedPooledObjectFactory
public BaseKeyedPooledObjectFactory()
-
-
Method Details
-
activateObject
Reinitialize an instance to be returned by the pool.The default implementation is a no-op.
- Specified by:
activateObjectin interfaceKeyedPooledObjectFactory<K,V> - Parameters:
key- the key used when selecting the objectp- aPooledObjectwrapping the instance to be activated- Throws:
Exception- if there is a problem activatingobj, this exception may be swallowed by the pool.- See Also:
-
create
Create 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.
-
destroyObject
Destroy an instance no longer needed by the pool.The default implementation is a no-op.
- Specified by:
destroyObjectin interfaceKeyedPooledObjectFactory<K,V> - Parameters:
key- the key used when selecting the instancep- aPooledObjectwrapping the instance to be destroyed- Throws:
Exception- should be avoided as it may be swallowed by the pool implementation.- See Also:
-
makeObject
Description copied from interface:KeyedPooledObjectFactoryCreates an instance that can be served by the pool and wrap it in aPooledObjectto be managed by the pool.- Specified by:
makeObjectin interfaceKeyedPooledObjectFactory<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.
-
passivateObject
Uninitialize an instance to be returned to the idle object pool.The default implementation is a no-op.
- Specified by:
passivateObjectin interfaceKeyedPooledObjectFactory<K,V> - Parameters:
key- the key used when selecting the objectp- aPooledObjectwrapping the instance to be passivated- Throws:
Exception- if there is a problem passivatingobj, this exception may be swallowed by the pool.- See Also:
-
validateObject
Ensures that the instance is safe to be returned by the pool.The default implementation always returns
true.- Specified by:
validateObjectin interfaceKeyedPooledObjectFactory<K,V> - Parameters:
key- the key used when selecting the objectp- aPooledObjectwrapping the instance to be validated- Returns:
- always
truein the default implementation
-
wrap
Wrap the provided instance with an implementation ofPooledObject.- Parameters:
value- the instance to wrap- Returns:
- The provided instance, wrapped by a
PooledObject
-