Top Description Fields Constructors Methods
org.springframework.jdbc.datasource

public Class DelegatingDataSource

extends Object
implements DataSource, InitializingBean
Class Inheritance
All Implemented Interfaces
org.springframework.beans.factory.InitializingBean, javax.sql.DataSource, java.sql.Wrapper, javax.sql.CommonDataSource
Known Direct Subclasses
org.springframework.jdbc.datasource.LazyConnectionDataSourceProxy, org.springframework.jdbc.datasource.ShardingKeyDataSourceAdapter, org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy, org.springframework.jdbc.datasource.UserCredentialsDataSourceAdapter
Imports
java.io.PrintWriter, java.sql.Connection, .ConnectionBuilder, .SQLException, .ShardingKeyBuilder, java.util.logging.Logger, javax.sql.DataSource, org.springframework.beans.factory.InitializingBean, org.springframework.lang.Nullable, org.springframework.util.Assert
JDBC javax.sql.DataSource implementation that delegates all calls to a given target javax.sql.DataSource.

This class is meant to be subclassed, with subclasses overriding only those methods (such as getConnection()) that should not simply delegate to the target DataSource.

Author
Juergen Hoeller
Since
1.1
See Also
getConnection

Field Summary

Modifier and TypeField and Description
private DataSource
targetDataSource

Constructor Summary

AccessConstructor and Description
public
DelegatingDataSource()

Create a new DelegatingDataSource.

public
DelegatingDataSource(DataSource
the target DataSource
targetDataSource)

Create a new DelegatingDataSource.

Method Summary

Modifier and TypeMethod and Description
public void
afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

public ConnectionBuilder
createConnectionBuilder()

Overrides default javax.sql.DataSource.createConnectionBuilder.

Create a new ConnectionBuilder instance
public ShardingKeyBuilder
createShardingKeyBuilder()

Overrides default javax.sql.CommonDataSource.createShardingKeyBuilder.

Creates a new ShardingKeyBuilder instance
public Connection
getConnection()

Implements javax.sql.DataSource.getConnection.

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

public Connection
getConnection(String
the database user on whose behalf the connection is being made
username, String
the user's password
password)

Implements javax.sql.DataSource.getConnection.

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

public int
getLoginTimeout()

Implements javax.sql.DataSource.getLoginTimeout.

Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
public PrintWriter
getLogWriter()

Implements javax.sql.DataSource.getLogWriter.

Retrieves the log writer for this DataSource object.

public Logger
getParentLogger()

Implements javax.sql.CommonDataSource.getParentLogger.

Return the parent Logger of all the Loggers used by this data source.
public DataSource
getTargetDataSource()

Return the target DataSource that this DataSource should delegate to.

public boolean
isWrapperFor(Class<?>
a Class defining an interface.
iface)

Implements java.sql.Wrapper.isWrapperFor.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
protected DataSource
obtainTargetDataSource()

Obtain the target DataSource for actual use (never null).

public void
setLoginTimeout(int
the data source login time limit
seconds)

Implements javax.sql.DataSource.setLoginTimeout.

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.

public void
setLogWriter(PrintWriter
the new log writer; to disable logging, set to null
out)

Implements javax.sql.DataSource.setLogWriter.

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

public void
setTargetDataSource(DataSource targetDataSource)

Set the target DataSource that this DataSource should delegate to.

public <T> T
unwrap(Class<T>
A Class defining an interface that the result must implement.
iface)

Implements java.sql.Wrapper.unwrap.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

targetDataSourceback to summary
private DataSource targetDataSource
Annotations
@Nullable

Constructor Detail

DelegatingDataSourceback to summary
public DelegatingDataSource()

Create a new DelegatingDataSource.

See Also
setTargetDataSource
DelegatingDataSourceback to summary
public DelegatingDataSource(DataSource targetDataSource)

Create a new DelegatingDataSource.

Parameters
targetDataSource:DataSource

the target DataSource

Method Detail

afterPropertiesSetback to summary
public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations
@Override
createConnectionBuilderback to summary
public ConnectionBuilder createConnectionBuilder() throws SQLException

Overrides default javax.sql.DataSource.createConnectionBuilder.

Doc from javax.sql.DataSource.createConnectionBuilder.

Create a new ConnectionBuilder instance

Returns:ConnectionBuilder

The ConnectionBuilder instance that was created

Annotations
@Override
Exceptions
SQLException:
if an error occurs creating the builder
createShardingKeyBuilderback to summary
public ShardingKeyBuilder createShardingKeyBuilder() throws SQLException

Overrides default javax.sql.CommonDataSource.createShardingKeyBuilder.

Doc from javax.sql.CommonDataSource.createShardingKeyBuilder.

Creates a new ShardingKeyBuilder instance

Returns:ShardingKeyBuilder

The ShardingKeyBuilder instance that was created

Annotations
@Override
Exceptions
SQLException:
if an error occurs creating the builder
getConnectionback to summary
public Connection getConnection() throws SQLException

Implements javax.sql.DataSource.getConnection.

Doc from javax.sql.DataSource.getConnection.

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

Returns:Connection

a connection to the data source

Annotations
@Override
Exceptions
SQLException:
if a database access error occurs
getConnectionback to summary
public Connection getConnection(String username, String password) throws SQLException

Implements javax.sql.DataSource.getConnection.

Doc from javax.sql.DataSource.getConnection.

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

Parameters
username:String

the database user on whose behalf the connection is being made

password:String

the user's password

Returns:Connection

a connection to the data source

Annotations
@Override
Exceptions
SQLException:
if a database access error occurs
getLoginTimeoutback to summary
public int getLoginTimeout() throws SQLException

Implements javax.sql.DataSource.getLoginTimeout.

Doc from javax.sql.DataSource.getLoginTimeout.

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.

Returns:int

Doc from javax.sql.CommonDataSource.getLoginTimeout.

the data source login time limit

Annotations
@Override
Exceptions
SQLException:

Doc from javax.sql.CommonDataSource.getLoginTimeout.

if a database access error occurs.

getLogWriterback to summary
public PrintWriter getLogWriter() throws SQLException

Implements javax.sql.DataSource.getLogWriter.

Doc from javax.sql.DataSource.getLogWriter.

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.

Returns:PrintWriter

Doc from javax.sql.CommonDataSource.getLogWriter.

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

Annotations
@Override
Exceptions
SQLException:

Doc from javax.sql.CommonDataSource.getLogWriter.

if a database access error occurs

getParentLoggerback to summary
public Logger getParentLogger()

Implements javax.sql.CommonDataSource.getParentLogger.

Doc from javax.sql.CommonDataSource.getParentLogger.

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.

Returns:Logger

the parent Logger for this data source

Annotations
@Override
getTargetDataSourceback to summary
public DataSource getTargetDataSource()

Return the target DataSource that this DataSource should delegate to.

Annotations
@Nullable
isWrapperForback to summary
public boolean isWrapperFor(Class<?> iface) throws SQLException

Implements java.sql.Wrapper.isWrapperFor.

Doc from java.sql.Wrapper.isWrapperFor.

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.

Parameters
iface:Class<?>

a Class defining an interface.

Returns:boolean

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

Annotations
@Override
Exceptions
SQLException:
if an error occurs while determining whether this is a wrapper for an object with the given interface.
obtainTargetDataSourceback to summary
protected DataSource obtainTargetDataSource()

Obtain the target DataSource for actual use (never null).

Since
5.0
setLoginTimeoutback to summary
public void setLoginTimeout(int seconds) throws SQLException

Implements javax.sql.DataSource.setLoginTimeout.

Doc from javax.sql.DataSource.setLoginTimeout.

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.

Parameters
seconds:int

Doc from javax.sql.CommonDataSource.setLoginTimeout.

the data source login time limit

Annotations
@Override
Exceptions
SQLException:

Doc from javax.sql.CommonDataSource.setLoginTimeout.

if a database access error occurs.

setLogWriterback to summary
public void setLogWriter(PrintWriter out) throws SQLException

Implements javax.sql.DataSource.setLogWriter.

Doc from javax.sql.DataSource.setLogWriter.

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.

Parameters
out:PrintWriter

Doc from javax.sql.CommonDataSource.setLogWriter.

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

Annotations
@Override
Exceptions
SQLException:

Doc from javax.sql.CommonDataSource.setLogWriter.

if a database access error occurs

setTargetDataSourceback to summary
public void setTargetDataSource(DataSource targetDataSource)

Set the target DataSource that this DataSource should delegate to.

unwrapback to summary
public <T> T unwrap(Class<T> iface) throws SQLException

Implements java.sql.Wrapper.unwrap.

Doc from java.sql.Wrapper.unwrap.

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.

Parameters
<T>
the type of the class modeled by this Class object
iface:Class<T>

A Class defining an interface that the result must implement.

Returns:T

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

Annotations
@Override
@SuppressWarnings:unchecked
Exceptions
SQLException:
If no object found that implements the interface