Package org.springframework.r2dbc.connection.lookup

Class AbstractRoutingConnectionFactory

java.lang.Object

org.springframework.r2dbc.connection.lookup.AbstractRoutingConnectionFactory

All Implemented Interfaces:

ConnectionFactory, InitializingBean

public abstract class AbstractRoutingConnectionFactory
extends Object
implements ConnectionFactory, InitializingBean

Abstract ConnectionFactory implementation that routes create() calls to one of various target factories based on a lookup key. The latter is typically (but not necessarily) determined from some subscriber context.

Allows to configure a default target ConnectionFactory as a fallback.

Calls to getMetadata() are routed to the default ConnectionFactory if configured.

Since:

5.3

Author:

Mark Paluch, Jens Schauder

See Also:

• setTargetConnectionFactories(java.util.Map<?, ?>)
• setDefaultTargetConnectionFactory(java.lang.Object)
• determineCurrentLookupKey()

Constructor Summary

Constructors

Constructor	Description
AbstractRoutingConnectionFactory()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Delegates to initialize().
reactor.core.publisher.Mono<Connection>	create()
protected abstract reactor.core.publisher.Mono<Object>	determineCurrentLookupKey()	Determine the current lookup key.
protected reactor.core.publisher.Mono<ConnectionFactory>	determineTargetConnectionFactory()	Retrieve the current target ConnectionFactory.
ConnectionFactoryMetadata	getMetadata()
void	initialize()	Initialize the internal state of this AbstractRoutingConnectionFactory by resolving the configured target ConnectionFactories.
protected ConnectionFactory	resolveSpecifiedConnectionFactory(Object connectionFactory)	Resolve the specified connection factory object into a ConnectionFactory instance.
protected Object	resolveSpecifiedLookupKey(Object lookupKey)	Resolve the given lookup key object, as specified in the targetConnectionFactories map, into the actual lookup key to be used for matching with the current lookup key.
void	setConnectionFactoryLookup(ConnectionFactoryLookup connectionFactoryLookup)	Set the ConnectionFactoryLookup implementation to use for resolving connection factory name Strings in the targetConnectionFactories map.
void	setDefaultTargetConnectionFactory(Object defaultTargetConnectionFactory)	Specify the default target ConnectionFactory, if any.
void	setLenientFallback(boolean lenientFallback)	Specify whether to apply a lenient fallback to the default ConnectionFactory if no specific ConnectionFactory could be found for the current lookup key.
void	setTargetConnectionFactories(Map<?,?> targetConnectionFactories)	Specify the map of target ConnectionFactories, with the lookup key as key.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRoutingConnectionFactory

public AbstractRoutingConnectionFactory()

Method Details

setTargetConnectionFactories

public void setTargetConnectionFactories(Map<?,?> targetConnectionFactories)

Specify the map of target ConnectionFactories, with the lookup key as key. The mapped value can either be a corresponding ConnectionFactory instance or a connection factory name String (to be resolved via a ConnectionFactoryLookup).

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

setDefaultTargetConnectionFactory

public void setDefaultTargetConnectionFactory(Object defaultTargetConnectionFactory)

Specify the default target ConnectionFactory, if any.

The mapped value can either be a corresponding ConnectionFactory instance or a connection factory name String (to be resolved via a ConnectionFactoryLookup).

This ConnectionFactory will be used as target if none of the keyed targetConnectionFactories match the current lookup key.

setLenientFallback

public void setLenientFallback(boolean lenientFallback)

Specify whether to apply a lenient fallback to the default ConnectionFactory if no specific ConnectionFactory could be found for the current lookup key.

Default is true, accepting lookup keys without a corresponding entry in the target ConnectionFactory map - simply falling back to the default ConnectionFactory in that case.

Switch this flag to false if you would prefer the fallback to only apply when no lookup key was emitted. Lookup keys without a ConnectionFactory entry will then lead to an IllegalStateException.

See Also:

• setTargetConnectionFactories(java.util.Map<?, ?>)
• setDefaultTargetConnectionFactory(java.lang.Object)
• determineCurrentLookupKey()

setConnectionFactoryLookup

public void setConnectionFactoryLookup(ConnectionFactoryLookup connectionFactoryLookup)

Set the ConnectionFactoryLookup implementation to use for resolving connection factory name Strings in the targetConnectionFactories map.

afterPropertiesSet

public void afterPropertiesSet()

Delegates to initialize().

Specified by:

afterPropertiesSet in interface InitializingBean

initialize

public void initialize()

Initialize the internal state of this AbstractRoutingConnectionFactory by resolving the configured target ConnectionFactories.

Throws:

IllegalArgumentException - if the target ConnectionFactories have not been configured

Since:

6.1

See Also:

• setTargetConnectionFactories(Map)
• setDefaultTargetConnectionFactory(Object)

resolveSpecifiedLookupKey

protected Object resolveSpecifiedLookupKey(Object lookupKey)

Resolve the given lookup key object, as specified in the targetConnectionFactories 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 - the lookup key object as specified by the user

Returns:

the lookup key as needed for matching.

resolveSpecifiedConnectionFactory

protected ConnectionFactory resolveSpecifiedConnectionFactory(Object connectionFactory)
                                                       throws IllegalArgumentException

Resolve the specified connection factory object into a ConnectionFactory instance.

The default implementation handles ConnectionFactory instances and connection factory names (to be resolved via a ConnectionFactoryLookup).

Parameters:

connectionFactory - the connection factory value object as specified in the targetConnectionFactories map

Returns:

the resolved ConnectionFactory (never null)

Throws:

IllegalArgumentException - in case of an unsupported value type

create

public reactor.core.publisher.Mono<Connection> create()

Specified by:

create in interface ConnectionFactory

getMetadata

public ConnectionFactoryMetadata getMetadata()

Specified by:

getMetadata in interface ConnectionFactory

determineTargetConnectionFactory

protected reactor.core.publisher.Mono<ConnectionFactory> determineTargetConnectionFactory()

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

Returns:

Mono that emits the current ConnectionFactory as per determineCurrentLookupKey()

See Also:

• determineCurrentLookupKey()

determineCurrentLookupKey

protected abstract reactor.core.publisher.Mono<Object> determineCurrentLookupKey()

Determine the current lookup key. This will typically be implemented to check a subscriber context. Allows for arbitrary keys. The returned key needs to match the stored lookup key type, as resolved by the resolveSpecifiedLookupKey(java.lang.Object) method.

Returns:

Mono emitting the lookup key. May complete without emitting a value if no lookup key available