net.timewalker.ffmq4.utils.pool

Class ObjectPool<T>

java.lang.Object

net.timewalker.ffmq4.utils.pool.ObjectPool<T>

All Implemented Interfaces:

ObjectPoolMBean

Direct Known Subclasses:

AsyncTaskProcessorThreadPool

public abstract class ObjectPool<T>
extends Object
implements ObjectPoolMBean

ObjectPool

Field Summary

Fields

Modifier and Type	Field and Description
static int	WHEN_EXHAUSTED_BLOCK
static int	WHEN_EXHAUSTED_FAIL Exhaustion policies
static int	WHEN_EXHAUSTED_RETURN_NULL
static int	WHEN_EXHAUSTED_WAIT
static int	WHEN_EXHAUSTED_WAIT_RETURN_NULL

Constructor Summary

Constructors

Constructor and Description
ObjectPool(int minSize, int maxIdle, int maxSize, int exhaustionPolicy, long waitTimeout) Constructor

Method Summary

Modifier and Type	Method and Description
T	borrow() Borrow an object from the pool
void	close() Close the pool, destroying all objects
protected abstract T	createPoolObject() Create a new pool object
protected abstract void	destroyPoolObject(T poolObject) Destroy a pool object
static String	exhaustionPolicyAsString(int exhaustionPolicy)
int	getThreadPoolAvailableCount()
int	getThreadPoolExhaustionPolicy()
int	getThreadPoolMaxIdle()
int	getThreadPoolMaxSize()
int	getThreadPoolMinSize()
int	getThreadPoolPendingWaits()
int	getThreadPoolSize()
long	getThreadPoolWaitTimeout()
protected void	init()
void	release(T poolObject) Return an object to the pool

Methods inherited from class java.lang.Object

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

Field Detail

WHEN_EXHAUSTED_FAIL

public static final int WHEN_EXHAUSTED_FAIL

Exhaustion policies

See Also:

Constant Field Values

WHEN_EXHAUSTED_BLOCK

public static final int WHEN_EXHAUSTED_BLOCK

See Also:

Constant Field Values

WHEN_EXHAUSTED_WAIT

public static final int WHEN_EXHAUSTED_WAIT

See Also:

Constant Field Values

WHEN_EXHAUSTED_RETURN_NULL

public static final int WHEN_EXHAUSTED_RETURN_NULL

See Also:

Constant Field Values

WHEN_EXHAUSTED_WAIT_RETURN_NULL

public static final int WHEN_EXHAUSTED_WAIT_RETURN_NULL

See Also:

Constant Field Values

Constructor Detail

ObjectPool

public ObjectPool(int minSize,
                  int maxIdle,
                  int maxSize,
                  int exhaustionPolicy,
                  long waitTimeout)
           throws javax.jms.JMSException

Constructor

Throws:

javax.jms.JMSException

Method Detail

init

protected void init()
             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

borrow

public T borrow()
         throws javax.jms.JMSException

Borrow an object from the pool

Returns:

a pooled object

Throws:

javax.jms.JMSException

release

public void release(T poolObject)

Return an object to the pool

Parameters:

poolObject - a pooled object to be returned

close

public void close()

Close the pool, destroying all objects

createPoolObject

protected abstract T createPoolObject()
                               throws Exception

Create a new pool object

Returns:

an new pool object

Throws:

Exception - on creation error

destroyPoolObject

protected abstract void destroyPoolObject(T poolObject)
                                   throws Exception

Destroy a pool object

Parameters:

poolObject - the object to destroy

Throws:

Exception - on release error

getThreadPoolMaxIdle

public int getThreadPoolMaxIdle()

Specified by:

getThreadPoolMaxIdle in interface ObjectPoolMBean

Returns:

the maxIdle

getThreadPoolMinSize

public int getThreadPoolMinSize()

Specified by:

getThreadPoolMinSize in interface ObjectPoolMBean

Returns:

the minSize

getThreadPoolMaxSize

public int getThreadPoolMaxSize()

Specified by:

getThreadPoolMaxSize in interface ObjectPoolMBean

Returns:

the maxSize

getThreadPoolExhaustionPolicy

public int getThreadPoolExhaustionPolicy()

Specified by:

getThreadPoolExhaustionPolicy in interface ObjectPoolMBean

Returns:

the exhaustionPolicy

getThreadPoolWaitTimeout

public long getThreadPoolWaitTimeout()

Specified by:

getThreadPoolWaitTimeout in interface ObjectPoolMBean

Returns:

the waitTimeout

getThreadPoolAvailableCount

public int getThreadPoolAvailableCount()

Specified by:

getThreadPoolAvailableCount in interface ObjectPoolMBean

Returns:

the available count

getThreadPoolPendingWaits

public int getThreadPoolPendingWaits()

Specified by:

getThreadPoolPendingWaits in interface ObjectPoolMBean

Returns:

the pendingWaits

getThreadPoolSize

public int getThreadPoolSize()

Specified by:

getThreadPoolSize in interface ObjectPoolMBean

Returns:

the pool size

exhaustionPolicyAsString

public static String exhaustionPolicyAsString(int exhaustionPolicy)