org.springframework.integration.router

Class RecipientListRouter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.router.AbstractMessageRouter

org.springframework.integration.router.RecipientListRouter

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, IntegrationPattern, MessageRouter, RecipientListRouterManagement, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class RecipientListRouter
extends AbstractMessageRouter
implements RecipientListRouterManagement

 <recipient-list-router id="simpleRouter" input-channel="routingChannelA">
     <recipient channel="channel1"/>
     <recipient channel="channel2"/>
 </recipient-list-router>
 
 

A Message Router that sends Messages to a list of recipient channels. The recipients can be provided as a static list of MessageChannel instances via the setChannels(List) method, or for dynamic behavior, the values can be provided via the setRecipients(List) method.

For more advanced, programmatic control of dynamic recipient lists, consider using the @Router annotation or extending AbstractMappingMessageRouter instead.

Contrary to a standard <router .../> this handler will try to send to all channels that are configured as recipients. It is to channels what a publish subscribe channel is to endpoints.

Using this class only makes sense if it is essential to send messages on multiple channels instead of sending them to multiple handlers. If the latter is an option using a publish subscribe channel is the more flexible solution.

Author:

Mark Fisher, Oleg Zhurakousky, Artem Bilan, Liujiong, Gary Russell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecipientListRouter.Recipient

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
RecipientListRouter()

Method Summary

Modifier and Type	Method and Description
void	addRecipient(MessageChannel channel)
void	addRecipient(MessageChannel channel, MessageSelector selector)
void	addRecipient(String channelName) Add a recipient with channelName.
void	addRecipient(String channelName, MessageSelector selector)
void	addRecipient(String channelName, String selectorExpression) Add a recipient with channelName and expression.
protected Collection<MessageChannel>	determineTargetChannels(Message<?> message) Subclasses must implement this method to return a Collection of zero or more MessageChannels to which the given Message should be routed.
String	getComponentType() Subclasses may implement this method to provide component type information.
IntegrationPatternType	getIntegrationPatternType() Return a pattern type this component implements.
Collection<RecipientListRouter.Recipient>	getRecipients()
protected void	onInit() Subclasses may implement this for initialization logic.
int	removeRecipient(String channelName) Remove all recipients that match the channelName.
int	removeRecipient(String channelName, String selectorExpression) Remove all recipients that match the channelName and expression.
void	replaceRecipients(Properties recipientMappings) Replace recipient.
void	setChannels(List<MessageChannel> channels) Set the channels for this router.
void	setRecipientMappings(Map<String,String> recipientMappings) Set the recipients for this router.
void	setRecipients(List<RecipientListRouter.Recipient> recipients) Set the recipients for this router.

Methods inherited from class org.springframework.integration.router.AbstractMessageRouter

getDefaultOutputChannel, getMessagingTemplate, getRequiredConversionService, handleMessageInternal, setApplySequence, setDefaultOutputChannel, setDefaultOutputChannelName, setIgnoreSendFailures, setSendTimeout

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Detail

RecipientListRouter

public RecipientListRouter()

Method Detail

setChannels

public void setChannels(List<MessageChannel> channels)

Set the channels for this router. Either call this method or setRecipients(List) but not both. If MessageSelectors should be considered, then use setRecipients(List).

Parameters:

channels - The channels.

setRecipients

public void setRecipients(List<RecipientListRouter.Recipient> recipients)

Set the recipients for this router.

Parameters:

recipients - The recipients.

setRecipientMappings

@ManagedAttribute
public void setRecipientMappings(Map<String,String> recipientMappings)

Set the recipients for this router.

Specified by:

setRecipientMappings in interface RecipientListRouterManagement

Parameters:

recipientMappings - map contains channelName and expression

addRecipient

@ManagedOperation
public void addRecipient(String channelName,
                                           String selectorExpression)

Description copied from interface: RecipientListRouterManagement

Add a recipient with channelName and expression.

Specified by:

addRecipient in interface RecipientListRouterManagement

Parameters:

channelName - The channel name.

selectorExpression - The expression to filter the incoming message.

addRecipient

@ManagedOperation
public void addRecipient(String channelName)

Description copied from interface: RecipientListRouterManagement

Add a recipient with channelName.

Specified by:

addRecipient in interface RecipientListRouterManagement

Parameters:

channelName - The channel name.

addRecipient

public void addRecipient(String channelName,
                         MessageSelector selector)

addRecipient

public void addRecipient(MessageChannel channel)

addRecipient

public void addRecipient(MessageChannel channel,
                         MessageSelector selector)

removeRecipient

@ManagedOperation
public int removeRecipient(String channelName)

Description copied from interface: RecipientListRouterManagement

Remove all recipients that match the channelName.

Specified by:

removeRecipient in interface RecipientListRouterManagement

Parameters:

channelName - The channel name.

Returns:

The number of recipients removed.

removeRecipient

@ManagedOperation
public int removeRecipient(String channelName,
                                             String selectorExpression)

Description copied from interface: RecipientListRouterManagement

Remove all recipients that match the channelName and expression.

Specified by:

removeRecipient in interface RecipientListRouterManagement

Parameters:

channelName - The channel name.

selectorExpression - The expression to filter the incoming message

Returns:

The number of recipients removed.

replaceRecipients

@ManagedOperation
public void replaceRecipients(Properties recipientMappings)

Description copied from interface: RecipientListRouterManagement

Replace recipient.

Specified by:

replaceRecipients in interface RecipientListRouterManagement

Parameters:

recipientMappings - contain channelName and expression.

getRecipients

@ManagedAttribute
public Collection<RecipientListRouter.Recipient> getRecipients()

Specified by:

getRecipients in interface RecipientListRouterManagement

Returns:

an unmodifiable collection of recipients.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class AbstractMessageRouter

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Overrides:

getIntegrationPatternType in class AbstractMessageRouter

Returns:

the IntegrationPatternType this component implements.

determineTargetChannels

protected Collection<MessageChannel> determineTargetChannels(Message<?> message)

Description copied from class: AbstractMessageRouter

Subclasses must implement this method to return a Collection of zero or more MessageChannels to which the given Message should be routed.

Specified by:

determineTargetChannels in class AbstractMessageRouter

Parameters:

message - The message.

Returns:

The collection of message channels.

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageRouter