public class RecipientListRouter extends AbstractMessageRouter implements InitializingBean
<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.
| Modifier and Type | Class and Description |
|---|---|
static class |
RecipientListRouter.Recipient |
loggerHIGHEST_PRECEDENCE, LOWEST_PRECEDENCE| Constructor and Description |
|---|
RecipientListRouter() |
| Modifier and Type | Method and Description |
|---|---|
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.
|
void |
onInit()
Subclasses may implement this for initialization logic.
|
void |
setChannels(List<MessageChannel> channels)
Set the channels for this router.
|
void |
setRecipients(List<RecipientListRouter.Recipient> recipients)
Set the recipients for this router.
|
getMessagingTemplate, getRequiredConversionService, handleMessageInternal, setApplySequence, setDefaultOutputChannel, setDefaultOutputChannelName, setIgnoreSendFailures, setTimeoutgetOrder, handleMessage, setOrder, setShouldTrackafterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitafterPropertiesSetgetComponentNamepublic void setChannels(List<MessageChannel> channels)
setRecipients(List) but not both. If MessageSelectors should be
considered, then use setRecipients(List).channels - The channels.public void setRecipients(List<RecipientListRouter.Recipient> recipients)
recipients - The recipients.public String getComponentType()
IntegrationObjectSupportgetComponentType in interface NamedComponentgetComponentType in class AbstractMessageRouterpublic void onInit()
IntegrationObjectSupportonInit in class AbstractMessageRouterprotected Collection<MessageChannel> determineTargetChannels(Message<?> message)
AbstractMessageRouterdetermineTargetChannels in class AbstractMessageRoutermessage - The message.