org.beiter.michael.db

Class ConnectionFactory

java.lang.Object

org.beiter.michael.db.ConnectionFactory

public final class ConnectionFactory
extends Object

This class creates and manages JDBC Connection instances either from:

• a named JNDI managed connection or
• a connection pool that is maintained by the DataSourceFactory factory

Method Summary

Modifier and Type	Method and Description
static Connection	getConnection(ConnectionProperties poolSpec) Return a Connection instance from a pool that manages JDBC driver based connections.
static Connection	getConnection(String jndiName) Return a Connection instance for a JNDI managed JDBC connection.
static void	reset() Resets the internal state of the DataSourceFactory that manages the data source pools exposed by this factory.

Methods inherited from class java.lang.Object

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

Method Detail

getConnection

public static Connection getConnection(String jndiName)
                                throws FactoryException

Return a Connection instance for a JNDI managed JDBC connection.

Parameters:

jndiName - The JNDI connection name

Returns:

a JDBC connection

Throws:

FactoryException - When the connection cannot be retrieved from JNDI

NullPointerException - When jndiName is null

IllegalArgumentException - When jndiName is empty

getConnection

public static Connection getConnection(ConnectionProperties poolSpec)
                                throws FactoryException

Return a Connection instance from a pool that manages JDBC driver based connections.

The driver-based connection are managed in a connection pool. The pool is created using the provided properties for both the connection and the pool spec. Once the pool has been created, it is cached (based on URL and username), and can no longer be changed. Subsequent calls to this method will return a connection from the cached pool, and changes in the pool spec (e.g. changes to the size of the pool) will be ignored.

Parameters:

poolSpec - A connection pool spec that has the driver and url configured as non-empty strings

Returns:

a JDBC connection

Throws:

FactoryException - When the connection cannot be retrieved from the pool, or the pool cannot be created

NullPointerException - When the poolSpec, poolSpec.getDriver(), or poolSpec.getUrl() are null

IllegalArgumentException - When poolSpec.getDriver() or poolSpec.getUrl() are empty

reset

public static void reset()

Resets the internal state of the DataSourceFactory that manages the data source pools exposed by this factory.

This method does not release any resources that have been borrowed from the connection pools managed by this factory. To avoid resource leaks, you must close / return all connections to their pools before calling this method.