public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean
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.setTargetDataSources(java.util.Map<java.lang.Object, java.lang.Object>)
,
setDefaultTargetDataSource(java.lang.Object)
,
determineCurrentLookupKey()
logger
Constructor and Description |
---|
AbstractRoutingDataSource() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
|
protected abstract java.lang.Object |
determineCurrentLookupKey()
Determine the current lookup key.
|
protected javax.sql.DataSource |
determineTargetDataSource()
Retrieve the current target DataSource.
|
java.sql.Connection |
getConnection() |
java.sql.Connection |
getConnection(java.lang.String username,
java.lang.String password) |
boolean |
isWrapperFor(java.lang.Class<?> iface) |
protected javax.sql.DataSource |
resolveSpecifiedDataSource(java.lang.Object dataSource)
Resolve the specified data source object into a DataSource instance.
|
protected java.lang.Object |
resolveSpecifiedLookupKey(java.lang.Object lookupKey)
Resolve the given lookup key object, as specified in the
targetDataSources map, into
the actual lookup key to be used for matching with the
current lookup key . |
void |
setDataSourceLookup(DataSourceLookup dataSourceLookup)
Set the DataSourceLookup implementation to use for resolving data source
name Strings in the
targetDataSources map. |
void |
setDefaultTargetDataSource(java.lang.Object defaultTargetDataSource)
Specify the default target DataSource, if any.
|
void |
setLenientFallback(boolean lenientFallback)
Specify whether to apply a lenient fallback to the default DataSource
if no specific DataSource could be found for the current lookup key.
|
void |
setTargetDataSources(java.util.Map<java.lang.Object,java.lang.Object> targetDataSources)
Specify the map of target DataSources, with the lookup key as key.
|
<T> T |
unwrap(java.lang.Class<T> iface) |
getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter
public void setTargetDataSources(java.util.Map<java.lang.Object,java.lang.Object> targetDataSources)
DataSource
instance or a data source name String (to be resolved via a
DataSourceLookup
).
The key can be of arbitrary type; this class implements the
generic lookup process only. The concrete key representation will
be handled by resolveSpecifiedLookupKey(Object)
and
determineCurrentLookupKey()
.
public void setDefaultTargetDataSource(java.lang.Object defaultTargetDataSource)
The mapped value can either be a corresponding DataSource
instance or a data source name String (to be resolved via a
DataSourceLookup
).
This DataSource will be used as target if none of the keyed
targetDataSources
match the
determineCurrentLookupKey()
current lookup key.
public void setLenientFallback(boolean lenientFallback)
Default is "true", accepting lookup keys without a corresponding entry in the target DataSource map - simply falling back to the default DataSource in that case.
Switch this flag to "false" if you would prefer the fallback to only apply
if the lookup key was null
. Lookup keys without a DataSource
entry will then lead to an IllegalStateException.
public void setDataSourceLookup(@Nullable DataSourceLookup dataSourceLookup)
targetDataSources
map.
Default is a JndiDataSourceLookup
, allowing the JNDI names
of application server DataSources to be specified directly.
public void afterPropertiesSet()
InitializingBean
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet
in interface InitializingBean
protected java.lang.Object resolveSpecifiedLookupKey(java.lang.Object lookupKey)
targetDataSources
map, into
the actual lookup key to be used for matching with the
current lookup key
.
The default implementation simply returns the given key as-is.
lookupKey
- the lookup key object as specified by the userprotected javax.sql.DataSource resolveSpecifiedDataSource(java.lang.Object dataSource) throws java.lang.IllegalArgumentException
The default implementation handles DataSource instances and data source
names (to be resolved via a DataSourceLookup
).
dataSource
- the data source value object as specified in the
targetDataSources
mapnull
)java.lang.IllegalArgumentException
- in case of an unsupported value typepublic java.sql.Connection getConnection() throws java.sql.SQLException
getConnection
in interface javax.sql.DataSource
java.sql.SQLException
public java.sql.Connection getConnection(java.lang.String username, java.lang.String password) throws java.sql.SQLException
getConnection
in interface javax.sql.DataSource
java.sql.SQLException
public <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLException
unwrap
in interface java.sql.Wrapper
unwrap
in class AbstractDataSource
java.sql.SQLException
public boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLException
isWrapperFor
in interface java.sql.Wrapper
isWrapperFor
in class AbstractDataSource
java.sql.SQLException
protected javax.sql.DataSource determineTargetDataSource()
current lookup key
, performs
a lookup in the targetDataSources
map,
falls back to the specified
default target DataSource
if necessary.determineCurrentLookupKey()
@Nullable protected abstract java.lang.Object determineCurrentLookupKey()
Allows for arbitrary keys. The returned key needs
to match the stored lookup key type, as resolved by the
resolveSpecifiedLookupKey(java.lang.Object)
method.