org.apache.commons.pool
Interface PoolableObjectFactory
- BasePoolableObjectFactory
public interface PoolableObjectFactory
An interface defining life-cycle methods for
instances to be used in an
ObjectPool
.
By contract, when an
ObjectPool
delegates to a
PoolableObjectFactory,
-
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 obj) - Reinitialize an instance to be returned by the pool.
|
void | destroyObject(Object obj) - Destroys an instance no longer needed by the pool.
|
Object | makeObject() - Creates an instance that can be returned by the pool.
|
void | passivateObject(Object obj) - Uninitialize an instance to be returned to the pool.
|
boolean | validateObject(Object obj) - Ensures that the instance is safe to be returned by the pool.
|
activateObject
public void activateObject(Object obj)
throws Exception
Reinitialize an instance to be returned by the pool.
obj
- the instance to be activated
destroyObject
public void destroyObject(Object obj)
throws Exception
Destroys an instance no longer needed by the pool.
obj
- the instance to be destroyed
makeObject
public Object makeObject()
throws Exception
Creates an instance that can be returned by the pool.
- an instance that can be returned by the pool.
passivateObject
public void passivateObject(Object obj)
throws Exception
Uninitialize an instance to be returned to the pool.
obj
- the instance to be passivated
validateObject
public boolean validateObject(Object obj)
Ensures that the instance is safe to be returned by the pool.
Returns false if this object should be destroyed.
obj
- 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 April 6 2007.