org.apache.turbine.services.pool
Interface PoolService

All Superinterfaces:
FactoryService, Initable, Service
All Known Implementing Classes:
TurbinePoolService

public interface PoolService
extends FactoryService

The Pool Service extends the Factory Service by adding support for pooling instantiated objects. When a new instance is requested, the service first checks its pool if one is available. If the the pool is empty, a new object will be instantiated from the specified class. If only class name is given, the request to create an intance will be forwarded to the Factory Service.

For objects implementing the Recyclable interface, a recycle method will be called, when they are taken from the pool, and a dispose method, when they are returned to the pool.

Version:
$Id$
Author:
Ilkka Priha

Field Summary
static int DEFAULT_POOL_CAPACITY
          The default pool capacity.
static java.lang.String SERVICE_NAME
          The key under which this service is stored in TurbineServices.
 
Method Summary
 void clearPool()
          Clears all instances from the pool.
 void clearPool(java.lang.String className)
          Clears instances of a named class from the pool.
 int getCapacity(java.lang.String className)
          Gets the capacity of the pool for a named class.
 java.lang.Object getInstance(java.lang.Class clazz)
          Gets an instance of a specified class either from the pool or by instatiating from the class if the pool is empty.
 java.lang.Object getInstance(java.lang.Class clazz, java.lang.Object[] params, java.lang.String[] signature)
          Gets an instance of a specified class either from the pool or by instatiating from the class if the pool is empty.
 int getSize(java.lang.String className)
          Gets the current size of the pool for a named class.
 boolean putInstance(java.lang.Object instance)
          Puts a used object back to the pool.
 void setCapacity(java.lang.String className, int capacity)
          Sets the capacity of the pool for a named class.
 
Methods inherited from interface org.apache.turbine.services.factory.FactoryService
getInstance, getInstance, getInstance, getInstance, isLoaderSupported
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
The key under which this service is stored in TurbineServices.

DEFAULT_POOL_CAPACITY

public static final int DEFAULT_POOL_CAPACITY
The default pool capacity.
Method Detail

getInstance

public java.lang.Object getInstance(java.lang.Class clazz)
                             throws TurbineException
Gets an instance of a specified class either from the pool or by instatiating from the class if the pool is empty.
Parameters:
clazz - the class.
Returns:
the instance.
Throws:
TurbineException - if recycling fails.

getInstance

public java.lang.Object getInstance(java.lang.Class clazz,
                                    java.lang.Object[] params,
                                    java.lang.String[] signature)
                             throws TurbineException
Gets an instance of a specified class either from the pool or by instatiating from the class if the pool is empty.
Parameters:
clazz - the class.
params - an array containing the parameters of the constructor.
signature - an array containing the signature of the constructor.
Returns:
the instance.
Throws:
TurbineException - if recycling fails.

putInstance

public boolean putInstance(java.lang.Object instance)
Puts a used object back to the pool. Objects implementing the Recyclable interface can provide a recycle method to be called when they are reused and a dispose method to be called when they are returned to the pool.
Parameters:
instance - the object instance to recycle.
Returns:
true if the instance was accepted.

getCapacity

public int getCapacity(java.lang.String className)
Gets the capacity of the pool for a named class.
Parameters:
className - the name of the class.

setCapacity

public void setCapacity(java.lang.String className,
                        int capacity)
Sets the capacity of the pool for a named class. Note that the pool will be cleared after the change.
Parameters:
className - the name of the class.
capacity - the new capacity.

getSize

public int getSize(java.lang.String className)
Gets the current size of the pool for a named class.
Parameters:
className - the name of the class.

clearPool

public void clearPool(java.lang.String className)
Clears instances of a named class from the pool.
Parameters:
className - the name of the class.

clearPool

public void clearPool()
Clears all instances from the pool.


Copyright © 1999-2001 Apache Software Foundation. All Rights Reserved.