org.arp.javautil.sql

Class DataSourceConnectionSpec

java.lang.Object

org.arp.javautil.sql.AbstractConnectionSpec

org.arp.javautil.sql.DataSourceConnectionSpec

All Implemented Interfaces:

ConnectionSpec

public class DataSourceConnectionSpec
extends AbstractConnectionSpec

Implements getting a connection to a relational database using Java's DataSource API.

Author:

Andrew Post

See Also:

InitialContext

Constructor Summary

Constructors

Constructor and Description
DataSourceConnectionSpec(String jndiName)
DataSourceConnectionSpec(String jndiName, boolean autoCommitEnabled) Creates an instance that will get connections from the database with the specified JNDI name.
DataSourceConnectionSpec(String jndiName, Hashtable<?,?> environment, String user, String password)
DataSourceConnectionSpec(String jndiName, Hashtable<?,?> environment, String user, String password, boolean autoCommitEnabled) Creates an instance that will get connections from the database with the specified JNDI name using the specified username and password.
DataSourceConnectionSpec(String jndiName, String user, String password)
DataSourceConnectionSpec(String jndiName, String user, String password, boolean autoCommitEnabled) Creates an instance that will get connections from the database with the specified JNDI name using the specified username and password.

Method Summary

Modifier and Type	Method and Description
void	accept(ConnectionSpecVisitor connectionSpecVisitor) Performs some processing on this connection spec.
DataSource	getDataSource() Gets the specified data source.
Connection	getOrCreate() Creates a database connection or gets an existing connection with the JNDI name, username and password specified in the constructor.

Methods inherited from class org.arp.javautil.sql.AbstractConnectionSpec

getDatabaseProduct, getDatabaseVersion, getDriver, getDriverVersion, isAutoCommitEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceConnectionSpec

public DataSourceConnectionSpec(String jndiName,
                                boolean autoCommitEnabled)
                         throws NamingException

Creates an instance that will get connections from the database with the specified JNDI name.

Parameters:

jndiName - a JNDI name String.

Throws:

NamingException - if the specified JNDI name is invalid.

DataSourceConnectionSpec

public DataSourceConnectionSpec(String jndiName)
                         throws NamingException

Throws:

NamingException

DataSourceConnectionSpec

public DataSourceConnectionSpec(String jndiName,
                                String user,
                                String password,
                                boolean autoCommitEnabled)
                         throws NamingException

Creates an instance that will get connections from the database with the specified JNDI name using the specified username and password. No environment properties are supplied when looking up the JNDI name. See the javadoc for InitialContext for a description of environment properties.

Parameters:

jndiName - a JNDI name String.

user - a username String.

password - a password String.

Throws:

NamingException - if an error occurs during JNDI lookup.

DataSourceConnectionSpec

public DataSourceConnectionSpec(String jndiName,
                                String user,
                                String password)
                         throws NamingException

Throws:

NamingException

DataSourceConnectionSpec

public DataSourceConnectionSpec(String jndiName,
                                Hashtable<?,?> environment,
                                String user,
                                String password)
                         throws NamingException

Throws:

NamingException

DataSourceConnectionSpec

public DataSourceConnectionSpec(String jndiName,
                                Hashtable<?,?> environment,
                                String user,
                                String password,
                                boolean autoCommitEnabled)
                         throws NamingException

Creates an instance that will get connections from the database with the specified JNDI name using the specified username and password. The specified environment will be used when looking up the JNDI name. See the javadoc for InitialContext for a description of environment properties.

Parameters:

jndiName - a JNDI name String.

environment - a Hashtable of environment properties.

user - a username String.

password - a password String.

Throws:

NamingException - if an error occurs during JNDI lookup.

Method Detail

getOrCreate

public Connection getOrCreate()
                       throws SQLException

Creates a database connection or gets an existing connection with the JNDI name, username and password specified in the constructor.

Returns:

a Connection.

Throws:

SQLException - if an error occurred creating/getting a Connection, possibly because the JNDI name, username and/or password are invalid.

getDataSource

public DataSource getDataSource()

Gets the specified data source.

Returns:

a DataSource.

accept

public void accept(ConnectionSpecVisitor connectionSpecVisitor)

Description copied from interface: ConnectionSpec

Performs some processing on this connection spec.

Parameters:

connectionSpecVisitor - a ConnectionSpecVisitor.