org.openingo.spring.boot.extension.datasource.routing

Class RoutingDataSource

java.lang.Object

org.springframework.jdbc.datasource.AbstractDataSource

org.openingo.spring.boot.extension.datasource.routing.RoutingDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource, org.springframework.beans.factory.InitializingBean

public class RoutingDataSource
extends org.springframework.jdbc.datasource.AbstractDataSource
implements DataSource, org.springframework.beans.factory.InitializingBean

RoutingDataSource DataSource implementation that routes getConnection() calls to one of various target DataSources based on a lookup key. The latter is usually (but not necessarily) determined through some thread-bound transaction context.

Author:

Qicz

See Also:

setTargetDataSources(java.util.concurrent.ConcurrentHashMap<java.lang.Object, org.openingo.spring.boot.extension.datasource.provider.IDataSourceProvider>), setDefaultTargetDataSource(org.openingo.spring.boot.extension.datasource.provider.IDataSourceProvider), determineCurrentLookupKey()

Field Summary

Fields inherited from class org.springframework.jdbc.datasource.AbstractDataSource

logger

Constructor Summary

Constructors

Constructor and Description
RoutingDataSource()
RoutingDataSource(IDataSourceProvider defaultTargetDataSource)
RoutingDataSource(IDataSourceProvider defaultTargetDataSource, ConcurrentHashMap<Object,IDataSourceProvider> targetDataSources)

Method Summary

Modifier and Type	Method and Description
void	addDataSource(Object dataSourceKey, IDataSourceProvider dataSource) add a new dataSource
void	addDataSources(Map<Object,IDataSourceProvider> dataSources) add more dataSources
void	afterPropertiesSet()
protected Object	determineCurrentLookupKey() Determine the current lookup key.
protected DataSource	determineTargetDataSource() Retrieve the current target DataSource.
Connection	getConnection()
Connection	getConnection(String username, String password)
IDataSourceProvider	getCurrentUsingDataSourceProvider() Returns current using dataSource provider instance default is defaultTargetDataSource
Boolean	hasDataSource(Object dataSourceKey) the dataSource has the dataSourceKey is exists or not.
boolean	isWrapperFor(Class<?> iface)
void	preDestroy()
void	removeDataSource(Object dataSourceKey) remove the dataSource with the dataSourceKey
void	setAutoCloseSameKeyDataSource(Boolean autoCloseSameKeyDataSource) whether or not close the dataSource that has the same dataSource key
void	setDefaultTargetDataSource(IDataSourceProvider defaultTargetDataSource) Specify the default target DataSource, if any.
void	setTargetDataSources(ConcurrentHashMap<Object,IDataSourceProvider> targetDataSources) Specify the map of target DataSources, with the lookup key as key.
<T> T	unwrap(Class<T> iface)

Methods inherited from class org.springframework.jdbc.datasource.AbstractDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

Constructor Detail

RoutingDataSource

public RoutingDataSource()

RoutingDataSource

public RoutingDataSource(IDataSourceProvider defaultTargetDataSource)

RoutingDataSource

public RoutingDataSource(IDataSourceProvider defaultTargetDataSource,
                         ConcurrentHashMap<Object,IDataSourceProvider> targetDataSources)

Method Detail

setAutoCloseSameKeyDataSource

public void setAutoCloseSameKeyDataSource(Boolean autoCloseSameKeyDataSource)

whether or not close the dataSource that has the same dataSource key

Parameters:

autoCloseSameKeyDataSource - true close the dataSource that has the same dataSourceKey

hasDataSource

public Boolean hasDataSource(Object dataSourceKey)

the dataSource has the dataSourceKey is exists or not.

Parameters:

dataSourceKey - dataSource key

Returns:

true exists

addDataSource

public void addDataSource(Object dataSourceKey,
                          IDataSourceProvider dataSource)

add a new dataSource

Parameters:

dataSourceKey - dataSource key

dataSource - dataSource Provider

addDataSources

public void addDataSources(Map<Object,IDataSourceProvider> dataSources)

add more dataSources

Parameters:

dataSources - dataSource provider mapping

removeDataSource

public void removeDataSource(Object dataSourceKey)

remove the dataSource with the dataSourceKey

Parameters:

dataSourceKey - dataSource key dataSource key

preDestroy

@PreDestroy
public void preDestroy()

setTargetDataSources

public void setTargetDataSources(ConcurrentHashMap<Object,IDataSourceProvider> targetDataSources)

Specify the map of target DataSources, with the lookup key as key. The mapped value can either be a corresponding DataSource instance. determineCurrentLookupKey().

setDefaultTargetDataSource

public void setDefaultTargetDataSource(IDataSourceProvider defaultTargetDataSource)

Specify the default target DataSource, if any.

The mapped value can either be a corresponding DataSource instance. determineCurrentLookupKey() current lookup key.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

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

Specified by:

getConnection in interface DataSource

Throws:

SQLException

unwrap

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

Specified by:

unwrap in interface Wrapper

Overrides:

unwrap in class org.springframework.jdbc.datasource.AbstractDataSource

Throws:

SQLException

isWrapperFor

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

Specified by:

isWrapperFor in interface Wrapper

Overrides:

isWrapperFor in class org.springframework.jdbc.datasource.AbstractDataSource

Throws:

SQLException

determineTargetDataSource

protected DataSource determineTargetDataSource()

Retrieve the current target DataSource. Determines the current lookup key, performs a lookup in the targetDataSources map, falls back to the specified default target DataSource if necessary.

See Also:

determineCurrentLookupKey()

determineCurrentLookupKey

@Nullable
protected Object determineCurrentLookupKey()

Determine the current lookup key.

getCurrentUsingDataSourceProvider

public IDataSourceProvider getCurrentUsingDataSourceProvider()

Returns current using dataSource provider instance default is defaultTargetDataSource

Returns:

dataSource Instance