org.apache.commons.pool
Interface KeyedPoolableObjectFactory
- BaseKeyedPoolableObjectFactory
public interface KeyedPoolableObjectFactory
An interface defining life-cycle methods for
instances to be served by a
KeyedObjectPool
.
By contract, when an
KeyedObjectPool
delegates to a
KeyedPoolableObjectFactory,
-
makeObject
is called whenever a new instance is needed.
-
activateObject
is invoked on every instance before it is returned from the
pool.
-
passivateObject
is invoked on every instance when it is returned to the
pool.
-
destroyObject
is invoked on every instance when it is being "dropped" from the
pool (whether due to the response from
validateObject
, or
for reasons specific to the pool implementation.)
-
validateObject
is invoked in an implementation-specific fashion to determine if an instance
is still valid to be returned by the pool.
It will only be invoked on an "activated"
instance.
$Revision: 155430 $ $Date: 2005-02-26 08:13:28 -0500 (Sat, 26 Feb 2005) $ void | activateObject(Object key, Object obj) - Reinitialize an instance to be returned by the pool.
|
void | destroyObject(Object key, Object obj) - Destroy an instance no longer needed by the pool.
|
Object | makeObject(Object key) - Create an instance that can be served by the pool.
|
void | passivateObject(Object key, Object obj) - Uninitialize an instance to be returned to the pool.
|
boolean | validateObject(Object key, Object obj) - Ensures that the instance is safe to be returned by the pool.
|
activateObject
public void activateObject(Object key,
Object obj)
throws Exception
Reinitialize an instance to be returned by the pool.
key
- the key used when selecting the objectobj
- the instance to be activated
destroyObject
public void destroyObject(Object key,
Object obj)
throws Exception
Destroy an instance no longer needed by the pool.
key
- the key used when selecting the instanceobj
- the instance to be destroyed
makeObject
public Object makeObject(Object key)
throws Exception
Create an instance that can be served by the pool.
key
- the key used when constructing the object
- an instance that can be served by the pool.
passivateObject
public void passivateObject(Object key,
Object obj)
throws Exception
Uninitialize an instance to be returned to the pool.
key
- the key used when selecting the objectobj
- the instance to be passivated
validateObject
public boolean validateObject(Object key,
Object obj)
Ensures that the instance is safe to be returned by the pool.
Returns false if this instance should be destroyed.
key
- the key used when selecting the objectobj
- the instance to be validated
- false if this obj is not valid and should
be dropped from the pool, true otherwise.
Copyright © 2001-2003 Apache Software Foundation. Documenation generated September 26 2006.