Spring Framework 6.1.4 · org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource

Modifier and Type	Field and Description
private DataSourceLookup	dataSourceLookup
private Object	defaultTargetDataSource
private boolean	lenientFallback
private Map<Object, DataSource>	resolvedDataSources
private DataSource	resolvedDefaultDataSource
private Map<Object, Object>	targetDataSources

Access	Constructor and Description
public	AbstractRoutingDataSource()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Delegates to `initialize()`.
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
protected abstract Object	determineCurrentLookupKey() Determine the current lookup key.
protected DataSource	determineTargetDataSource() Retrieve the current target DataSource.
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 Map<Object, DataSource>	Returns: an unmodifiable map of resolved lookup keys and DataSources getResolvedDataSources() Return the resolved target DataSources that this router manages.
public DataSource	Returns: the default DataSource, or `null` if none or not resolved yet getResolvedDefaultDataSource() Return the resolved default target DataSource, if any.
public void	initialize() Initialize the internal state of this `AbstractRoutingDataSource` by resolving the configured target DataSources.
public boolean	isWrapperFor(Class<?> a Class defining an interface. iface) Overrides org.springframework.jdbc.datasource.AbstractDataSource.isWrapperFor. 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	Returns: the resolved DataSource (never `null`) resolveSpecifiedDataSource(Object the data source value object as specified in the `targetDataSources` map dataSourceObject) Resolve the specified data source object into a DataSource instance.
protected Object	Returns: the lookup key as needed for matching resolveSpecifiedLookupKey(Object the lookup key object as specified by the user 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`.
public void	setDataSourceLookup(DataSourceLookup dataSourceLookup) Set the DataSourceLookup implementation to use for resolving data source name Strings in the `targetDataSources` map.
public void	setDefaultTargetDataSource(Object defaultTargetDataSource) Specify the default target DataSource, if any.
public 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.
public void	setTargetDataSources(Map<Object, Object> targetDataSources) Specify the map of target DataSources, with the lookup key as key.
public <T> T	unwrap(Class<T> A Class defining an interface that the result must implement. iface) Overrides org.springframework.jdbc.datasource.AbstractDataSource.unwrap. 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 org.springframework.jdbc.datasource.AbstractDataSource:: getLoginTimeout getLogWriter getParentLogger setLoginTimeout setLogWriter

dataSourceLookup	back to summary
private DataSourceLookup dataSourceLookup

defaultTargetDataSource	back to summary
private Object defaultTargetDataSource Annotations @Nullable

lenientFallback	back to summary
private boolean lenientFallback

resolvedDataSources	back to summary
private Map<Object, DataSource> resolvedDataSources Annotations @Nullable

resolvedDefaultDataSource	back to summary
private DataSource resolvedDefaultDataSource Annotations @Nullable

targetDataSources	back to summary
private Map<Object, Object> targetDataSources Annotations @Nullable

AbstractRoutingDataSource	back to summary
public AbstractRoutingDataSource()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Delegates to `initialize()`. Annotations @Override

public void afterPropertiesSet()

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

Delegates to initialize().

Annotations

@Override

createConnectionBuilder back to summary

createConnectionBuilder	back 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

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

createShardingKeyBuilder back to summary

createShardingKeyBuilder	back 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

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

determineCurrentLookupKey back to summary

determineCurrentLookupKey	back to summary
protected abstract Object determineCurrentLookupKey() Determine the current lookup key. This will typically be implemented to check a thread-bound transaction context. Allows for arbitrary keys. The returned key needs to match the stored lookup key type, as resolved by the `resolveSpecifiedLookupKey` method. Annotations @Nullable

protected abstract Object determineCurrentLookupKey()

Determine the current lookup key. This will typically be implemented to check a thread-bound transaction context.

Allows for arbitrary keys. The returned key needs to match the stored lookup key type, as resolved by the resolveSpecifiedLookupKey method.

Annotations

@Nullable

determineTargetDataSource back to summary

determineTargetDataSource	back to summary
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()`

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()

getConnection back to summary

getConnection	back 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

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

getConnection back to summary

getConnection	back 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

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

getResolvedDataSources back to summary

getResolvedDataSources	back to summary
public Map<Object, DataSource> getResolvedDataSources() Return the resolved target DataSources that this router manages. Returns:Map<Object, DataSource> an unmodifiable map of resolved lookup keys and DataSources Exceptions IllegalStateException: if the target DataSources are not resolved yet Since 5.2.9 See Also `setTargetDataSources`

public Map<Object, DataSource> getResolvedDataSources()

Return the resolved target DataSources that this router manages.

Returns:Map<Object, DataSource>

an unmodifiable map of resolved lookup keys and DataSources

Exceptions

IllegalStateException:: if the target DataSources are not resolved yet

Since

5.2.9

See Also

setTargetDataSources

getResolvedDefaultDataSource back to summary

getResolvedDefaultDataSource	back to summary
public DataSource getResolvedDefaultDataSource() Return the resolved default target DataSource, if any. Returns:DataSource the default DataSource, or `null` if none or not resolved yet Annotations @Nullable Since 5.2.9 See Also `setDefaultTargetDataSource`

public DataSource getResolvedDefaultDataSource()

Return the resolved default target DataSource, if any.

Returns:DataSource

the default DataSource, or null if none or not resolved yet

Annotations

@Nullable

Since

5.2.9

See Also

setDefaultTargetDataSource

initialize back to summary

initialize	back to summary
public void initialize() Initialize the internal state of this `AbstractRoutingDataSource` by resolving the configured target DataSources. Exceptions IllegalArgumentException: if the target DataSources have not been configured Since 6.1 See Also `setTargetDataSources(Map)`, `setDefaultTargetDataSource(Object)`, `getResolvedDataSources()`, `getResolvedDefaultDataSource()`

public void initialize()

Initialize the internal state of this AbstractRoutingDataSource by resolving the configured target DataSources.

Exceptions

IllegalArgumentException:: if the target DataSources have not been configured

Since

6.1

isWrapperFor back to summary

isWrapperFor	back to summary
public boolean isWrapperFor(Class<?> iface) throws SQLException Overrides org.springframework.jdbc.datasource.AbstractDataSource.isWrapperFor. 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.

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

Overrides org.springframework.jdbc.datasource.AbstractDataSource.isWrapperFor.

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.

resolveSpecifiedDataSource back to summary

resolveSpecifiedDataSource	back to summary
protected DataSource resolveSpecifiedDataSource(Object dataSourceObject) throws IllegalArgumentException Resolve the specified data source object into a DataSource instance. The default implementation handles DataSource instances and data source names (to be resolved via a `DataSourceLookup`). Parameters dataSourceObject:Object the data source value object as specified in the `targetDataSources` map Returns:DataSource the resolved DataSource (never `null`) Exceptions IllegalArgumentException: in case of an unsupported value type

protected DataSource resolveSpecifiedDataSource(Object dataSourceObject) throws IllegalArgumentException

Resolve the specified data source object into a DataSource instance.

The default implementation handles DataSource instances and data source names (to be resolved via a DataSourceLookup).

Parameters

dataSourceObject:Object: the data source value object as specified in the targetDataSources map

Returns:DataSource

the resolved DataSource (never null)

Exceptions

IllegalArgumentException:: in case of an unsupported value type

resolveSpecifiedLookupKey back to summary

resolveSpecifiedLookupKey	back to summary
protected Object resolveSpecifiedLookupKey(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`. The default implementation simply returns the given key as-is. Parameters lookupKey:Object the lookup key object as specified by the user Returns:Object the lookup key as needed for matching

protected Object resolveSpecifiedLookupKey(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.

The default implementation simply returns the given key as-is.

Parameters

lookupKey:Object: the lookup key object as specified by the user

Returns:Object

the lookup key as needed for matching

setDataSourceLookup back to summary

setDataSourceLookup	back to summary
public void setDataSourceLookup(DataSourceLookup dataSourceLookup) Set the DataSourceLookup implementation to use for resolving data source name Strings in the `targetDataSources` map. Default is a `JndiDataSourceLookup`, allowing the JNDI names of application server DataSources to be specified directly.

public void setDataSourceLookup(DataSourceLookup dataSourceLookup)

Set the DataSourceLookup implementation to use for resolving data source name Strings in the targetDataSources map.

Default is a JndiDataSourceLookup, allowing the JNDI names of application server DataSources to be specified directly.

setDefaultTargetDataSource back to summary

setDefaultTargetDataSource	back to summary
public void setDefaultTargetDataSource(Object defaultTargetDataSource) Specify the default target DataSource, if any. The mapped value can either be a corresponding `javax.sql.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 setDefaultTargetDataSource(Object defaultTargetDataSource)

Specify the default target DataSource, if any.

The mapped value can either be a corresponding javax.sql.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.

setLenientFallback back to summary

setLenientFallback	back to summary
public 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. 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. See Also `setTargetDataSources`, `setDefaultTargetDataSource`, `determineCurrentLookupKey()`

public 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.

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.

See Also: setTargetDataSources, setDefaultTargetDataSource, determineCurrentLookupKey()

setTargetDataSources back to summary

setTargetDataSources	back to summary
public void setTargetDataSources(Map<Object, Object> targetDataSources) Specify the map of target DataSources, with the lookup key as key. The mapped value can either be a corresponding `javax.sql.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 setTargetDataSources(Map<Object, Object> targetDataSources)

Specify the map of target DataSources, with the lookup key as key.

The mapped value can either be a corresponding javax.sql.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().

unwrap back to summary

unwrap	back to summary
public <T> T unwrap(Class<T> iface) throws SQLException Overrides org.springframework.jdbc.datasource.AbstractDataSource.unwrap. 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

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

Overrides org.springframework.jdbc.datasource.AbstractDataSource.unwrap.

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

public abstract Class AbstractRoutingDataSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail