org.beiter.michael.db

Class DataSourceFactory

java.lang.Object

org.beiter.michael.db.DataSourceFactory

public final class DataSourceFactory
extends Object

This class creates and manages JDBC Data Source instances either from:

• a named JNDI managed data source or
• a data source pool that is maintained by this factory

Method Summary

Modifier and Type	Method and Description
static DataSource	getDataSource(ConnectionProperties poolSpec) Return a DataSource instance from a pool that manages JDBC driver based connections.
static DataSource	getDataSource(String jndiName) Return a DataSource instance for a JNDI managed JDBC data source.
static void	reset() Resets the internal state of the factory.

Methods inherited from class java.lang.Object

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

Method Detail

getDataSource

public static DataSource getDataSource(String jndiName)
                                throws FactoryException

Return a DataSource instance for a JNDI managed JDBC data source.

Parameters:

jndiName - The JNDI connection name

Returns:

a JDBC data source

Throws:

FactoryException - When no date source can be retrieved from JNDI

NullPointerException - When jndiName is null

IllegalArgumentException - When jndiName is empty

getDataSource

public static DataSource getDataSource(ConnectionProperties poolSpec)
                                throws FactoryException

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

The driver-based data sources are managed in a data source pool. The pool is created using the provided properties for both the connection / data source and the pool spec. Once the pool has been created, it is cached (based on the connection parameters, i.e. the URL and username), and can no longer be changed. Subsequent calls to this method will return a data source 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 data source 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 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.