com.bankframe.ei.txnhandler.connector.offline
Class OffLineConnectionPool

java.lang.Object
  com.bankframe.ei.txnhandler.connector.offline.OffLineConnectionPool

All Implemented Interfaces:

java.io.Serializable

public class OffLineConnectionPool

extends java.lang.Object

implements java.io.Serializable

This class is a Connection Pool for the OffLine Connector. It stores and manages a series of physical (EManaged) connections to the offline database. This class is used in conjunction with the OffLineConnectionManager, for situations where a JDBC DataSource object is available from the appliacation server.

See Also:

Serialized Form

Constructor Summary

OffLineConnectionPool(java.lang.String name, int maxConns, int timeOut)
OffLineConnectionPool constructor.

Method Summary

void	addConnection(EManagedConnection conn) This method adds a connection to the pool of available connections.
void	freeConnection(EManagedConnection conn) This method frees (makes available for use) a connection in the pool that was currently in use.
EManagedConnection	getConnection(EManagedConnectionFactory mcf, java.lang.String properties) This method gets a managed connection from the pool.
java.util.Set	getFreeConnections() This method returns the Set of free connections available in the pool.
java.lang.String	getName() This method gets the name of this pool.
void	release() This method releases all existing free connections in the Connection Pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

OffLineConnectionPool

public OffLineConnectionPool(java.lang.String name,
                             int maxConns,
                             int timeOut)

OffLineConnectionPool constructor.

Parameters:

name - The name of the Pool to be created.

maxConns - The maximum connections allowable.

timeOut - The max amount of time to wait for a connection that is not available.

Method Detail

addConnection

public void addConnection(EManagedConnection conn)

This method adds a connection to the pool of available connections.

Parameters:

conn - The connection to add to the pool.

freeConnection

public void freeConnection(EManagedConnection conn)

This method frees (makes available for use) a connection in the pool that was currently in use.

Parameters:

conn - The connection to free in the pool.

getConnection

public EManagedConnection getConnection(EManagedConnectionFactory mcf,
                                        java.lang.String properties)
                                 throws java.sql.SQLException

This method gets a managed connection from the pool. If no matching connections are available, and we haven't reached the maximum, then a new connection will be created.

Parameters:

mcf - The ManagedConnectionFactory for creation of a new connection if necessary.

properties - A String of semi-colon delimited property values to be associated with this connection.

Returns:

An EManagedConnection to access the offline database.

Throws:

java.sql.SQLException

getFreeConnections

public java.util.Set getFreeConnections()

This method returns the Set of free connections available in the pool.

Returns:

A Set of free connections.

getName

public java.lang.String getName()

This method gets the name of this pool.

Returns:

The name of this pool.

release

public void release()

This method releases all existing free connections in the Connection Pool. i.e. they are physically closed and no longer available for use.