Package org.springframework.amqp.rabbitmq.client

Class AbstractRoutingAmqpConnectionFactory

java.lang.Object

org.springframework.amqp.rabbitmq.client.AbstractRoutingAmqpConnectionFactory

All Implemented Interfaces:

AmqpConnectionFactory, RoutingAmqpConnectionFactory, InitializingBean

Direct Known Subclasses:

SimpleRoutingAmqpConnectionFactory

public abstract class AbstractRoutingAmqpConnectionFactory
extends Object
implements AmqpConnectionFactory, RoutingAmqpConnectionFactory, InitializingBean

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

Since:

4.2

Author:

Robin Collard

Constructor Summary

Constructors

Constructor	Description
AbstractRoutingAmqpConnectionFactory()

Method Summary

Modifier and Type	Method	Description
void	addTargetConnectionFactory(Object key, AmqpConnectionFactory connectionFactory)	Add the given AmqpConnectionFactory and associate it with the given lookup key.
void	afterPropertiesSet()
protected abstract @Nullable Object	determineCurrentLookupKey()	Determine the current lookup key.
protected AmqpConnectionFactory	determineTargetConnectionFactory()	Retrieve the current target AmqpConnectionFactory.
com.rabbitmq.client.amqp.Connection	getConnection()
@Nullable AmqpConnectionFactory	getTargetConnectionFactory(Object key)	Return the AmqpConnectionFactory bound to given lookup key, or null if one does not exist.
protected boolean	isLenientFallback()
@Nullable AmqpConnectionFactory	removeTargetConnectionFactory(Object key)	Remove the AmqpConnectionFactory associated with the given lookup key and return it.
void	setDefaultTargetConnectionFactory(AmqpConnectionFactory defaultTargetConnectionFactory)	Specify the default target AmqpConnectionFactory, if any.
void	setLenientFallback(boolean lenientFallback)	Specify whether to apply a lenient fallback to the default AmqpConnectionFactory if no specific AmqpConnectionFactory could be found for the current lookup key.
void	setTargetConnectionFactories(Map<Object,AmqpConnectionFactory> targetConnectionFactories)	Specify the map of target AmqpConnectionFactories, 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

AbstractRoutingAmqpConnectionFactory

public AbstractRoutingAmqpConnectionFactory()

Method Details

setTargetConnectionFactories

public void setTargetConnectionFactories(Map<Object,AmqpConnectionFactory> targetConnectionFactories)

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

The key can be of arbitrary type; this class implements the generic lookup process only. The concrete key representation will be handled by determineCurrentLookupKey().

Parameters:

targetConnectionFactories - the target connection factories and lookup keys.

setDefaultTargetConnectionFactory

public void setDefaultTargetConnectionFactory(AmqpConnectionFactory defaultTargetConnectionFactory)

Specify the default target AmqpConnectionFactory, if any.

This AmqpConnectionFactory will be used as target if none of the keyed targetConnectionFactories match the determineCurrentLookupKey() current lookup key.

Parameters:

defaultTargetConnectionFactory - the default target connection factory.

setLenientFallback

public void setLenientFallback(boolean lenientFallback)

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

Default is "true", accepting lookup keys without a corresponding entry in the targetConnectionFactories - simply falling back to the default AmqpConnectionFactory 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 an AmqpConnectionFactory entry will then lead to an IllegalStateException.

Parameters:

lenientFallback - true to fall back to the default, if specified.

See Also:

• setTargetConnectionFactories(java.util.Map<java.lang.Object, org.springframework.amqp.rabbitmq.client.AmqpConnectionFactory>)
• setDefaultTargetConnectionFactory(org.springframework.amqp.rabbitmq.client.AmqpConnectionFactory)
• determineCurrentLookupKey()

isLenientFallback

protected boolean isLenientFallback()

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

getConnection

public com.rabbitmq.client.amqp.Connection getConnection()

Specified by:

getConnection in interface AmqpConnectionFactory

determineTargetConnectionFactory

protected AmqpConnectionFactory determineTargetConnectionFactory()

Retrieve the current target AmqpConnectionFactory. Determine the current lookup key, perform a lookup in the targetConnectionFactories map, fall back to the specified defaultTargetConnectionFactory if necessary.

Returns:

the connection factory.

See Also:

• determineCurrentLookupKey()

getTargetConnectionFactory

public @Nullable AmqpConnectionFactory getTargetConnectionFactory(Object key)

Description copied from interface: RoutingAmqpConnectionFactory

Return the AmqpConnectionFactory bound to given lookup key, or null if one does not exist.

Specified by:

getTargetConnectionFactory in interface RoutingAmqpConnectionFactory

Parameters:

key - the lookup key to which the AmqpConnectionFactory is bound.

Returns:

the AmqpConnectionFactory bound to the given lookup key, or null if one does not exist.

addTargetConnectionFactory

public void addTargetConnectionFactory(Object key,
 AmqpConnectionFactory connectionFactory)

Add the given AmqpConnectionFactory and associate it with the given lookup key.

Parameters:

key - the lookup key.

connectionFactory - the AmqpConnectionFactory.

removeTargetConnectionFactory

public @Nullable AmqpConnectionFactory removeTargetConnectionFactory(Object key)

Remove the AmqpConnectionFactory associated with the given lookup key and return it.

Parameters:

key - the lookup key.

Returns:

the AmqpConnectionFactory that was removed.

determineCurrentLookupKey

protected abstract @Nullable Object determineCurrentLookupKey()

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

Returns:

the lookup key.