com.att.ajsc.csilogging.util

Class ObjectPool

java.lang.Object

com.att.ajsc.csilogging.util.ObjectPool

All Implemented Interfaces:

DynamicMBean

public class ObjectPool
extends Object
implements DynamicMBean

Field Summary

Fields

Modifier and Type	Field and Description
static String	AVAILABLE
static String	CURRENT_POOL_SIZE
static String	MAX_CONCURRENCY
static String	POOL_MANAGER
static String	POOL_TYPE
static String	TOTAL_OBJECTS_CREATED
static String	TOTAL_OBJECTS_DESTROYED
static String	TOTAL_TIMES_ACQUIRED

Constructor Summary

Constructors

Constructor and Description
ObjectPool(String poolTypeName, PoolableObjectCreator poolableObjectCreator) Creates an ObjectPool with the specified PoolableObjectCreator and assigns it to the supplied PoolType (poolTypeName) and default poolManager.
ObjectPool(String poolTypeName, String poolManagerName, PoolableObjectCreator poolableObjectCreator) Creates an ObjectPool with the specified PoolableObjectCreator and assigns it to the supplied PoolType (poolTypeName) and poolManager (poolManagerName).

Method Summary

Modifier and Type	Method and Description
Object	acquirePoolableObject() Returns an Object of the pool (one from the pool if it exists, otherwise, creates a new one).
void	clean() Invoked by the PoolManager over a specified interval to shrink the pool if necessary.
MBeanInfo	createMBeanInfo() Privately used function to create and return the MBeanInfo object associated with this ObjectPool.
Object	getAttribute(String attribute)
AttributeList	getAttributes(String[] attributes)
MBeanInfo	getMBeanInfo() Provides lazy instantiation of the ObjectPool's MBeanInfo, yet allows for reuse.
Object	invoke(String actionName, Object[] params, String[] signature)
static void	registerManagement(String name, ObjectPool objectPool) Registers the ObjectPool's MBean.
void	release(Object object) Returns the supplied Object back to the pool.
void	setAttribute(Attribute attribute)
AttributeList	setAttributes(AttributeList attributes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CURRENT_POOL_SIZE

public static final String CURRENT_POOL_SIZE

See Also:

Constant Field Values

AVAILABLE

public static final String AVAILABLE

See Also:

Constant Field Values

TOTAL_OBJECTS_CREATED

public static final String TOTAL_OBJECTS_CREATED

See Also:

Constant Field Values

TOTAL_OBJECTS_DESTROYED

public static final String TOTAL_OBJECTS_DESTROYED

See Also:

Constant Field Values

TOTAL_TIMES_ACQUIRED

public static final String TOTAL_TIMES_ACQUIRED

See Also:

Constant Field Values

MAX_CONCURRENCY

public static final String MAX_CONCURRENCY

See Also:

Constant Field Values

POOL_TYPE

public static final String POOL_TYPE

See Also:

Constant Field Values

POOL_MANAGER

public static final String POOL_MANAGER

See Also:

Constant Field Values

Constructor Detail

ObjectPool

public ObjectPool(String poolTypeName,
                  PoolableObjectCreator poolableObjectCreator)

Creates an ObjectPool with the specified PoolableObjectCreator and assigns it to the supplied PoolType (poolTypeName) and default poolManager. The resulting ObjectPool is initialized to its minimum size and registered with the pool manager for cleanup invocations.

Parameters:

poolTypeName - The name of the PoolType to associate the ObjectPool with.

poolableObjectCreator - The PoolableObjectCreator used to create new Objects.

ObjectPool

public ObjectPool(String poolTypeName,
                  String poolManagerName,
                  PoolableObjectCreator poolableObjectCreator)

Creates an ObjectPool with the specified PoolableObjectCreator and assigns it to the supplied PoolType (poolTypeName) and poolManager (poolManagerName). The resulting ObjectPool is initialized to its minimum size and registered with the pool manager for cleanup invocations.

Parameters:

poolTypeName - The name of the PoolType to associate the ObjectPool with.

poolManagerName - The name of the PoolManager to register the ObjectPool with.

poolableObjectCreator - The PoolableObjectCreator used to create new Objects.

Method Detail

release

public void release(Object object)

Returns the supplied Object back to the pool.

Parameters:

object - The Object to return to the pool.

acquirePoolableObject

public Object acquirePoolableObject()

Returns an Object of the pool (one from the pool if it exists, otherwise, creates a new one).

Returns:

An Object of the pool.

clean

public void clean()

Invoked by the PoolManager over a specified interval to shrink the pool if necessary. Rules: 1. We never shrink below the minimum pool size 2. We never shrink lower then the maxConcurrncy used over the last interval plus 1 If minimum pool size was increased during the last interval via JMX, we adjust accordingly.

registerManagement

public static void registerManagement(String name,
                                      ObjectPool objectPool)

Registers the ObjectPool's MBean.

Parameters:

name - The name of the ObjectPool.

objectPool - The ObjectPool to register.

getAttribute

public Object getAttribute(String attribute)
                    throws AttributeNotFoundException,
                           MBeanException,
                           ReflectionException

Specified by:

getAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

MBeanException

ReflectionException

getMBeanInfo

public MBeanInfo getMBeanInfo()

Provides lazy instantiation of the ObjectPool's MBeanInfo, yet allows for reuse.

Specified by:

getMBeanInfo in interface DynamicMBean

Returns:

The ObjectPool's MBeanInfo object.

createMBeanInfo

public MBeanInfo createMBeanInfo()

Privately used function to create and return the MBeanInfo object associated with this ObjectPool.

Returns:

The ObjectPool's MBeanInfo object.

getAttributes

public AttributeList getAttributes(String[] attributes)

Specified by:

getAttributes in interface DynamicMBean

invoke

public Object invoke(String actionName,
                     Object[] params,
                     String[] signature)
              throws MBeanException,
                     ReflectionException

Specified by:

invoke in interface DynamicMBean

Throws:

MBeanException

ReflectionException

setAttributes

public AttributeList setAttributes(AttributeList attributes)

Specified by:

setAttributes in interface DynamicMBean

setAttribute

public void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException

Specified by:

setAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

InvalidAttributeValueException

MBeanException

ReflectionException