org.arp.javautil.sql

Class DataSourceInitialContextBinder

java.lang.Object

org.arp.javautil.sql.DataSourceInitialContextBinder

All Implemented Interfaces:

AutoCloseable

public class DataSourceInitialContextBinder
extends Object
implements AutoCloseable

Utility class for binding DataSources easily to the usual JNDI names (java:/comp/env/jdbc/<DataSourceName>). Sets the Context.INITIAL_CONTEXT_FACTORY and Context.URL_PKG_PREFIXES system properties when loaded by the class loader.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
DataSourceInitialContextBinder() Creates an instance of this class, setting up an InitialContext to use.

Method Summary

Modifier and Type	Method and Description
void	bind(String name, DataSource dataSource) Binds a data source to a name.
void	close() Unbinds all data sources currently bound by this instance of this class.
void	unbind(DataSource dataSource) Unbinds a data source.
void	unbindAll() Unbinds all data sources that were previously bound by this instance of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceInitialContextBinder

public DataSourceInitialContextBinder()
                               throws NamingException

Creates an instance of this class, setting up an InitialContext to use.

Throws:

NamingException - if an error occurs setting up the InitialContext.

Method Detail

bind

public void bind(String name,
                 DataSource dataSource)
          throws NamingException

Binds a data source to a name. The given name will be prepended with java:/comp/env/jdbc/.

Parameters:

name - the name to which to bind the given data source.

dataSource - a DataSource.

Throws:

NamingException - if an error occurs during binding.

unbind

public void unbind(DataSource dataSource)
            throws NamingException

Unbinds a data source.

Parameters:

dataSource - the DataSource to unbind.

Throws:

NamingException - if an error occurs during unbinding.

unbindAll

public void unbindAll()
               throws NamingException

Unbinds all data sources that were previously bound by this instance of this class.

Throws:

NamingException - if an error occurs during unbinding.

close

public void close()
           throws Exception

Unbinds all data sources currently bound by this instance of this class. If successful, it then closes the InitialContext.

Specified by:

close in interface AutoCloseable

Throws:

Exception - if an error occurs during unbinding or closing.