org.apache.commons.pool

Interface KeyedPoolableObjectFactory

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,

  1. makeObject is called whenever a new instance is needed.
  2. activateObject is invoked on every instance before it is returned from the pool.
  3. passivateObject is invoked on every instance when it is returned to the pool.
  4. 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.)
  5. 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.

Version: $Revision: 155430 $ $Date: 2005-02-26 08:13:28 -0500 (Sat, 26 Feb 2005) $

Author: Rodney Waldhoff

See Also:

Method Summary
voidactivateObject(Object key, Object obj)
Reinitialize an instance to be returned by the pool.
voiddestroyObject(Object key, Object obj)
Destroy an instance no longer needed by the pool.
ObjectmakeObject(Object key)
Create an instance that can be served by the pool.
voidpassivateObject(Object key, Object obj)
Uninitialize an instance to be returned to the pool.
booleanvalidateObject(Object key, Object obj)
Ensures that the instance is safe to be returned by the pool.

Method Detail

activateObject

public void activateObject(Object key, Object obj)
Reinitialize an instance to be returned by the pool.

Parameters: key the key used when selecting the object obj the instance to be activated

destroyObject

public void destroyObject(Object key, Object obj)
Destroy an instance no longer needed by the pool.

Parameters: key the key used when selecting the instance obj the instance to be destroyed

makeObject

public Object makeObject(Object key)
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.

passivateObject

public void passivateObject(Object key, Object obj)
Uninitialize an instance to be returned to the pool.

Parameters: key the key used when selecting the object obj 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.

Parameters: key the key used when selecting the object obj the instance to be validated

Returns: false if this obj is not valid and should be dropped from the pool, true otherwise.

Copyright © 2001-2003 Apache Software Foundation. Documenation generated August 23 2012.