gov.va.vinci.leo.tools.db

Class LeoDataSource

java.lang.Object

gov.va.vinci.leo.tools.db.LeoDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource

public class LeoDataSource
extends Object
implements DataSource

DataSource that creates/manages the database connection and returns a reference to the connection object. User: Thomas Ginter Date: 7/17/14 Time: 14:08

Field Summary

Fields

Modifier and Type	Field and Description
protected Connection	mConn Database connection object.
protected String	mDriver JDBC driver class name.
protected String	mUrl JDBC database connection URL.

Constructor Summary

Constructors

Constructor and Description
LeoDataSource(Connection conn) Initialize the DataSource with the connection object.
LeoDataSource(String driver, String url, String username, String password) Initialize the DataSource with the connection information.

Method Summary

Modifier and Type	Method and Description
protected void	connect(String driver, String url, String user, String pwd) Connect to the database.
Connection	getConnection() Attempts to establish a connection with the data source that this DataSource object represents.
Connection	getConnection(String username, String password) Attempts to establish a connection with the data source that this DataSource object represents.
int	getLoginTimeout() Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
PrintWriter	getLogWriter() Retrieves the log writer for this DataSource object.
Logger	getParentLogger() Return the parent Logger of all the Loggers used by this data source.
boolean	isWrapperFor(Class<?> iface) Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
void	setLoginTimeout(int seconds) Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
void	setLogWriter(PrintWriter out) Sets the log writer for this DataSource object to the given java.io.PrintWriter object.
<T> T	unwrap(Class<T> iface) Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

Methods inherited from class java.lang.Object

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

Field Detail

mConn

protected Connection mConn

Database connection object.

mDriver

protected String mDriver

JDBC driver class name.

mUrl

protected String mUrl

JDBC database connection URL.

Constructor Detail

LeoDataSource

public LeoDataSource(Connection conn)
              throws SQLException

Initialize the DataSource with the connection object.

Parameters:

conn - connection object to use

Throws:

SQLException - if there is an error getting the MetaData from the connection object

LeoDataSource

public LeoDataSource(String driver,
                     String url,
                     String username,
                     String password)
              throws SQLException,
                     ClassNotFoundException

Initialize the DataSource with the connection information.

Parameters:

driver - JDBC driver class name

url - JDBC connection URL

username - database user name

password - database user password

Throws:

SQLException - if there is an error connecting to the database

ClassNotFoundException - if the driver class is not in the classpath

Method Detail

connect

protected void connect(String driver,
                       String url,
                       String user,
                       String pwd)
                throws ClassNotFoundException,
                       SQLException

Connect to the database.

Parameters:

driver - Database driver class

url - URL for the connection.

user - Username. If null, the connection is made without using a username and password.

pwd - Password if needed.

Throws:

ClassNotFoundException - thrown if the JDBC driver cannot be found.

SQLException - thrown if there is an exception with the query or result set.

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

Retrieves the log writer for this DataSource object.

The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

Specified by:

getLogWriter in interface CommonDataSource

Returns:

the log writer for this data source or null if logging is disabled

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

setLogWriter(java.io.PrintWriter)

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

Sets the log writer for this DataSource object to the given java.io.PrintWriter object.

The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled.

Specified by:

setLogWriter in interface CommonDataSource

Parameters:

out - the new log writer; to disable logging, set to null

Throws:

SQLException - if a database access error occurs

Since:

1.4

See Also:

getLogWriter()

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

Specified by:

setLoginTimeout in interface CommonDataSource

Parameters:

seconds - the data source login time limit

Throws:

SQLException - if a database access error occurs.

Since:

1.4

See Also:

getLoginTimeout()

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

Specified by:

getLoginTimeout in interface CommonDataSource

Returns:

the data source login time limit

Throws:

SQLException - if a database access error occurs.

Since:

1.4

See Also:

setLoginTimeout(int)

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Return the parent Logger of all the Loggers used by this data source. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source. Configuring this Logger will affect all of the log messages generated by the data source. In the worst case, this may be the root Logger.

Specified by:

getParentLogger in interface CommonDataSource

Returns:

the parent Logger for this data source

Throws:

SQLFeatureNotSupportedException - if the data source does not use java.util.logging.

Since:

1.7

getConnection

public Connection getConnection()
                         throws SQLException

Attempts to establish a connection with the data source that this DataSource object represents.

Specified by:

getConnection in interface DataSource

Returns:

a connection to the data source

Throws:

SQLException - if a database access error occurs

getConnection

public Connection getConnection(String username,
                                String password)
                         throws SQLException

Attempts to establish a connection with the data source that this DataSource object represents.

Specified by:

getConnection in interface DataSource

Parameters:

username - the database user on whose behalf the connection is being made

password - the user's password

Returns:

a connection to the data source

Throws:

SQLException - if a database access error occurs

Since:

1.4

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Specified by:

unwrap in interface Wrapper

Parameters:

iface - A Class defining an interface that the result must implement.

Returns:

an object that implements the interface. May be a proxy for the actual implementing object.

Throws:

SQLException - If no object found that implements the interface

Since:

1.6

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Specified by:

isWrapperFor in interface Wrapper

Parameters:

iface - a Class defining an interface.

Returns:

true if this implements the interface or directly or indirectly wraps an object that does.

Throws:

SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.

Since:

1.6