| org.apache.turbine.services.pool.PoolService
All known Subclasses: org.apache.turbine.services.pool.TurbinePoolService,
| PoolService | | public interface PoolService extends Service(Code) | | 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.
author:
Ilkka Priha
version:
$Id: PoolService.java 534527 2007-05-02 16:10:59Z tv $ |
| Method Summary | |
| void | clearPool(String className)
Clears instances of a named class from the pool. | | void | clearPool()
Clears all instances from the pool. | | int | getCapacity(String className)
Gets the capacity of the pool for a named class. | | Object | getInstance(String className)
Gets an instance of a named class.
Parameters:
className - the name of the class. | | Object | getInstance(String className, ClassLoader loader)
Gets an instance of a named class using a specified class loader.
Class loaders are supported only if the isLoaderSupported
method returns true. | | Object | getInstance(String className, Object[] params, String[] signature)
Gets an instance of a named class.
Parameters for its constructor are given as an array of objects,
primitive types must be wrapped with a corresponding class.
Parameters:
className - the name of the class.
Parameters:
params - an array containing the parameters of the constructor.
Parameters:
signature - an array containing the signature of the constructor. | | Object | getInstance(String className, ClassLoader loader, Object[] params, String[] signature)
Gets an instance of a named class using a specified class loader.
Parameters for its constructor are given as an array of objects,
primitive types must be wrapped with a corresponding class.
Class loaders are supported only if the isLoaderSupported
method returns true. | | Object | getInstance(Class clazz)
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. | | Object | getInstance(Class clazz, Object params, String signature)
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.
Parameters:
params - an array containing the parameters of the constructor.
Parameters:
signature - an array containing the signature of the constructor. | | int | getSize(String className)
Gets the current size of the pool for a named class. | | boolean | isLoaderSupported(String className)
Tests if specified class loaders are supported for a named class.
Parameters:
className - the name of the class. | | boolean | putInstance(Object instance)
Puts a used object back to the pool. | | void | setCapacity(String className, int capacity)
Sets the capacity of the pool for a named class. |
| DEFAULT_POOL_CAPACITY | | int DEFAULT_POOL_CAPACITY(Code) | | The default pool capacity.
|
| POOL_CAPACITY_KEY | | String POOL_CAPACITY_KEY(Code) | | The name of the pool capacity property
|
| POOL_DEBUG_DEFAULT | | boolean POOL_DEBUG_DEFAULT(Code) | | Default Value for debug mode
|
| POOL_DEBUG_KEY | | String POOL_DEBUG_KEY(Code) | | Are we running in debug mode?
|
| SERVICE_NAME | | String SERVICE_NAME(Code) | | The key under which this service is stored in TurbineServices.
|
| clearPool | | void clearPool(String className)(Code) | | Clears instances of a named class from the pool.
Parameters:
className - the name of the class. |
| clearPool | | void clearPool()(Code) | | Clears all instances from the pool.
|
| getCapacity | | int getCapacity(String className)(Code) | | Gets the capacity of the pool for a named class.
Parameters:
className - the name of the class. |
| getInstance | | Object getInstance(String className, ClassLoader loader) throws TurbineException(Code) | | Gets an instance of a named class using a specified class loader.
Class loaders are supported only if the isLoaderSupported
method returns true. Otherwise the loader parameter is ignored.
Parameters:
className - the name of the class.
Parameters:
loader - the class loader. the instance.
throws:
TurbineException - if instantiation fails. |
| getInstance | | Object getInstance(String className, Object[] params, String[] signature) throws TurbineException(Code) | | Gets an instance of a named class.
Parameters for its constructor are given as an array of objects,
primitive types must be wrapped with a corresponding class.
Parameters:
className - the name of the class.
Parameters:
params - an array containing the parameters of the constructor.
Parameters:
signature - an array containing the signature of the constructor. the instance.
throws:
TurbineException - if instantiation fails. |
| getInstance | | Object getInstance(String className, ClassLoader loader, Object[] params, String[] signature) throws TurbineException(Code) | | Gets an instance of a named class using a specified class loader.
Parameters for its constructor are given as an array of objects,
primitive types must be wrapped with a corresponding class.
Class loaders are supported only if the isLoaderSupported
method returns true. Otherwise the loader parameter is ignored.
Parameters:
className - the name of the class.
Parameters:
loader - the class loader.
Parameters:
params - an array containing the parameters of the constructor.
Parameters:
signature - an array containing the signature of the constructor. the instance.
throws:
TurbineException - if instantiation fails. |
| getInstance | | Object getInstance(Class clazz) throws TurbineException(Code) | | 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. the instance.
throws:
TurbineException - if recycling fails. |
| getInstance | | Object getInstance(Class clazz, Object params, String signature) throws TurbineException(Code) | | 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.
Parameters:
params - an array containing the parameters of the constructor.
Parameters:
signature - an array containing the signature of the constructor. the instance.
throws:
TurbineException - if recycling fails. |
| getSize | | int getSize(String className)(Code) | | Gets the current size of the pool for a named class.
Parameters:
className - the name of the class. |
| isLoaderSupported | | boolean isLoaderSupported(String className) throws TurbineException(Code) | | Tests if specified class loaders are supported for a named class.
Parameters:
className - the name of the class. true if class loaders are supported, false otherwise.
throws:
TurbineException - if test fails. |
| putInstance | | boolean putInstance(Object instance)(Code) | | 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. true if the instance was accepted. |
| setCapacity | | void setCapacity(String className, int capacity)(Code) | | 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.
Parameters:
capacity - the new capacity. |
|
|