com.dpslink.base.as400

Class AS400PoolManager

java.lang.Object

com.dpslink.base.as400.AS400PoolManager

All Implemented Interfaces:

java.io.Serializable

public class AS400PoolManager
extends java.lang.Object
implements java.io.Serializable

The manager for AS400 connection pool(s). Provides the interface used by an application to obtain connections from a pool and to return connections to a pool.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	cvActive A flag indicating if the pools are currently active.
private static java.util.Hashtable<java.lang.String,AS400ConnectionPool>	cvPools The connection pools for the AS400PoolManager.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
AS400PoolManager()

Method Summary

Modifier and Type	Method and Description
private static void	createPools() Creates the AS400ConnectionPool objects.
static void	freeBadConnection(com.ibm.as400.access.AS400 conn) Discards a used connection in an assumed pool.
static void	freeBadConnection(java.lang.String name, com.ibm.as400.access.AS400 conn) Discards a used connection in the specified pool.
static void	freeConnection(com.ibm.as400.access.AS400 conn) Returns a connection back to an assumed pool.
static void	freeConnection(java.lang.String name, com.ibm.as400.access.AS400 conn) Returns a connection back to the specified pool.
static com.ibm.as400.access.AS400	getConnection() Retrieves a connection from an assumed pool.
static com.ibm.as400.access.AS400	getConnection(java.lang.String name) Retrieves a connection from the specified pool.
static java.lang.String	getConnectionConsumers(java.lang.String name) Returns a sorted list of the connection consumers associated with the connections currently in-use, suitable for display on a web page (list is delimited by <br>).
static java.lang.String	getConnectionStats(java.lang.String name) Returns a string containing information on total number of connections, number of checked out connections, and number of available ones.
static boolean	hasPools() Answers if any connection pools are configured.
static boolean	isActive() Answers if the set of connection pools being managed is active.
static void	restart() Allows the pool to process connections normally.
static void	stopAll() Shuts down the connection pools and forces the pool to to refuse further connections until restarted.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvPools

private static java.util.Hashtable<java.lang.String,AS400ConnectionPool> cvPools

The connection pools for the AS400PoolManager.

cvActive

private static boolean cvActive

A flag indicating if the pools are currently active. If not active, no connections are allowed.

Constructor Detail

AS400PoolManager

public AS400PoolManager()

Method Detail

createPools

private static void createPools()

Creates the AS400ConnectionPool objects.

freeConnection

public static void freeConnection(com.ibm.as400.access.AS400 conn)

Returns a connection back to an assumed pool. The assumed pool is the first pool in the set of pools. This method is intended as a convenience shortcut when there is only one pool in the set.

Parameters:

conn - (AS400) The connection to return.

freeConnection

public static void freeConnection(java.lang.String name,
                                  com.ibm.as400.access.AS400 conn)

Returns a connection back to the specified pool.

Parameters:

name - (String) A connection pool name.

conn - (AS400) The connection to return.

freeBadConnection

public static void freeBadConnection(com.ibm.as400.access.AS400 conn)

Discards a used connection in an assumed pool. Does not return the connection back to the pool. Only the counter of checked-out connections is decreased. The actual connection is dropped. This method is intended as a convenience shortcut when there is only one pool in the set.

Parameters:

conn - (AS400) The connection to discard.

freeBadConnection

public static void freeBadConnection(java.lang.String name,
                                     com.ibm.as400.access.AS400 conn)

Discards a used connection in the specified pool. Does not return the connection back to the pool. Only the counter of checked-out connections is decreased. The actual connection is dropped.

Parameters:

name - (String) A connection pool name.

conn - (AS400) The connection to discard.

getConnection

public static com.ibm.as400.access.AS400 getConnection()

Retrieves a connection from an assumed pool. The assumed pool is the first pool in the set of pools. This method is intended as a convenience shortcut when there is only one pool in the set.

Returns:

AS400 - A connection from the pool.

getConnection

public static com.ibm.as400.access.AS400 getConnection(java.lang.String name)

Retrieves a connection from the specified pool.

Parameters:

name - (String) A connection pool name.

Returns:

AS400 - A connection from the pool.

getConnectionConsumers

public static java.lang.String getConnectionConsumers(java.lang.String name)

Returns a sorted list of the connection consumers associated with the connections currently in-use, suitable for display on a web page (list is delimited by <br>).

Parameters:

name - (String) A connection pool name.

Returns:

String - The connection consumers for the connections currently being used.

getConnectionStats

public static java.lang.String getConnectionStats(java.lang.String name)

Returns a string containing information on total number of connections, number of checked out connections, and number of available ones.

Parameters:

name - (String) A connection pool name.

Returns:

String - The current connection statistics.

hasPools

public static boolean hasPools()

Answers if any connection pools are configured.

Returns:

boolean - true if pools are configured, otherwise false.

isActive

public static boolean isActive()

Answers if the set of connection pools being managed is active.

Returns:

boolean - true if the set of pools is active, otherwise false.

restart

public static void restart()

Allows the pool to process connections normally. Usually called after a stopAll().

stopAll

public static void stopAll()

Shuts down the connection pools and forces the pool to to refuse further connections until restarted.