org.arp.javautil.sql

Enum DatabaseAPI

java.lang.Object

java.lang.Enum<DatabaseAPI>

org.arp.javautil.sql.DatabaseAPI

All Implemented Interfaces:

Serializable, Comparable<DatabaseAPI>

public enum DatabaseAPI
extends Enum<DatabaseAPI>

An enum of Java's APIs ((DriverManager and DataSource) for connecting to relational databases. It provides a straightforward means for programs to make use of either without having to hard-code the API choice. This is useful in developing a library that may be used in a standalone program or in a container. Usage: public class DatabaseAPIExample { private DatabaseAPI databaseAPI; private String databaseId; private String username; private String password; public DatabaseAPIExample(DatabaseAPI databaseAPI, String databaseId, String username, String password) { this.databaseAPI = databasePID; this.databaseId = databaseId; this.username = username; this.password = password; } public void doProcessData() { ConnectionSpec connectionSpec = this.databaseAPI.newConnectionSpecInstance( this.databaseId, this.username, this.password); ... } }

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATASOURCE
DRIVERMANAGER

Method Summary

Modifier and Type	Method and Description
ConnectionSpec	newConnectionSpecInstance(String databaseId, String username, String password) Gets a ConnectionSpec implementation that is specific to the selected database API for getting/creating a database Connection.
ConnectionSpec	newConnectionSpecInstance(String databaseId, String username, String password, boolean autoCommitEnabled) Gets a ConnectionSpec implementation that is specific to the selected database API for getting/creating a database Connection.
static DatabaseAPI	valueOf(String name) Returns the enum constant of this type with the specified name.
static DatabaseAPI[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DRIVERMANAGER

public static final DatabaseAPI DRIVERMANAGER

DATASOURCE

public static final DatabaseAPI DATASOURCE

Method Detail

values

public static DatabaseAPI[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DatabaseAPI c : DatabaseAPI.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DatabaseAPI valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

newConnectionSpecInstance

public ConnectionSpec newConnectionSpecInstance(String databaseId,
                                                String username,
                                                String password)
                                         throws InvalidConnectionSpecArguments

Gets a ConnectionSpec implementation that is specific to the selected database API for getting/creating a database Connection. Connections created from the returned instance will have auto commit set to true

Parameters:

databaseId - the identifier for the database (JDBC URL for the DriverManager API, JNDI name for the DataSource API.

username - the username (null if not applicable)

password - the password (null if not applicable)

Returns:

a ConnectionSpec.

Throws:

InvalidConnectionSpecArguments - if the databaseId is invalid.

newConnectionSpecInstance

public ConnectionSpec newConnectionSpecInstance(String databaseId,
                                                String username,
                                                String password,
                                                boolean autoCommitEnabled)
                                         throws InvalidConnectionSpecArguments

Gets a ConnectionSpec implementation that is specific to the selected database API for getting/creating a database Connection.

Parameters:

databaseId - the identifier for the database (JDBC URL for the DriverManager API, JNDI name for the DataSource API.

username - the username (null if not applicable)

password - the password (null if not applicable)

autoCommitEnabled - true to make connections created from the returned instance have auto commit turned on by default, false to make connections created from the returned instance to have auto commit turned off by default.

Returns:

a ConnectionSpec.

Throws:

InvalidConnectionSpecArguments - if the databaseId is invalid.