io.mats3.util.wrappers

Class DataSourceWrapper

java.lang.Object

io.mats3.util.wrappers.DataSourceWrapper

All Implemented Interfaces:

MatsFactory.MatsWrapper<javax.sql.DataSource>, java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource

Direct Known Subclasses:

DeferredConnectionProxyDataSourceWrapper

public class DataSourceWrapper
extends java.lang.Object
implements javax.sql.DataSource, MatsFactory.MatsWrapper<javax.sql.DataSource>

A base Wrapper for a JDBC DataSource, which simply implements DataSource, takes a DataSource instance and forwards all calls to that. Meant to be extended to add extra functionality, e.g. Spring integration.

Constructor Summary

Constructors

Constructor and Description
DataSourceWrapper() No-args constructor, which implies that you either need to invoke setWrappee(DataSource) before publishing the instance (making it available for other threads), or override unwrap() to provide the desired DataSource instance.
DataSourceWrapper(javax.sql.DataSource targetDataSource) Standard constructor, taking the wrapped DataSource instance.

Method Summary

Modifier and Type	Method and Description
java.sql.Connection	getConnection()
java.sql.Connection	getConnection(java.lang.String username, java.lang.String password)
int	getLoginTimeout()
java.io.PrintWriter	getLogWriter()
java.util.logging.Logger	getParentLogger()
boolean	isWrapperFor(java.lang.Class<?> iface)
void	setLoginTimeout(int seconds)
void	setLogWriter(java.io.PrintWriter out)
void	setWrappee(javax.sql.DataSource targetDataSource) Sets the wrapped DataSource, e.g.
java.lang.String	toString()
javax.sql.DataSource	unwrap()
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.mats3.MatsFactory.MatsWrapper

unwrapFully, unwrapTo

Constructor Detail

DataSourceWrapper

public DataSourceWrapper(javax.sql.DataSource targetDataSource)

Standard constructor, taking the wrapped DataSource instance.

Parameters:

targetDataSource - the DataSource instance which unwrap() will return (and hence all forwarded methods will use).

DataSourceWrapper

public DataSourceWrapper()

No-args constructor, which implies that you either need to invoke setWrappee(DataSource) before publishing the instance (making it available for other threads), or override unwrap() to provide the desired DataSource instance. In these cases, make sure to honor memory visibility semantics - i.e. establish a happens-before edge between the setting of the instance and any other threads getting it.

Method Detail

setWrappee

public void setWrappee(javax.sql.DataSource targetDataSource)

Sets the wrapped DataSource, e.g. in case you instantiated it with the no-args constructor. Do note that the field holding the wrapped instance is not volatile nor synchronized. This means that if you want to set it after it has been published to other threads, you will have to override both this method and unwrap() to provide for needed memory visibility semantics, i.e. establish a happens-before edge between the setting of the instance and any other threads getting it.

Specified by:

setWrappee in interface MatsFactory.MatsWrapper<javax.sql.DataSource>

Parameters:

targetDataSource - the DataSource which is returned by unwrap(), unless that is overridden.

unwrap

public javax.sql.DataSource unwrap()

Specified by:

unwrap in interface MatsFactory.MatsWrapper<javax.sql.DataSource>

Returns:

the wrapped DataSource. All forwarding methods invokes this method to get the wrapped DataSource, thus if you want to get creative wrt. how and when the DataSource is decided, you can override this method.

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getConnection

public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getLogWriter

public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException

Specified by:

getLogWriter in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

setLogWriter

public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException

Specified by:

setLogWriter in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException

Specified by:

setLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws java.sql.SQLException

Specified by:

getLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

getParentLogger

public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLFeatureNotSupportedException

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException

Specified by:

unwrap in interface java.sql.Wrapper

Throws:

java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Specified by:

isWrapperFor in interface java.sql.Wrapper

Throws:

java.sql.SQLException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object