org.springframework.integration.dsl

Class RouterSpec<K,R extends AbstractMappingMessageRouter>

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,reactor.util.function.Tuple2<F,H>>

org.springframework.integration.dsl.EndpointSpec<S,ConsumerEndpointFactoryBean,H>

org.springframework.integration.dsl.ConsumerEndpointSpec<S,R>

org.springframework.integration.dsl.AbstractRouterSpec<RouterSpec<K,R>,R>

org.springframework.integration.dsl.RouterSpec<K,R>

Type Parameters:

K - the key type.

R - the AbstractMappingMessageRouter implementation type.

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,R>>, ComponentsRegistration

public final class RouterSpec<K,R extends AbstractMappingMessageRouter>
extends AbstractRouterSpec<RouterSpec<K,R>,R>
implements ComponentsRegistration

The AbstractRouterSpec for an AbstractMappingMessageRouter.

Since:

5.0

Author:

Artem Bilan

Field Summary

Fields inherited from class org.springframework.integration.dsl.ConsumerEndpointSpec

adviceChain

Fields inherited from class org.springframework.integration.dsl.EndpointSpec

componentsToRegister, endpointFactoryBean, handler

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Method Summary

Modifier and Type	Method and Description
RouterSpec<K,R>	channelMapping(K key, java.lang.String channelName)
RouterSpec<K,R>	dynamicChannelLimit(int dynamicChannelLimit) Set a limit for how many dynamic channels are retained (for reporting purposes).
java.util.Map<java.lang.Object,java.lang.String>	getComponentsToRegister()
RouterSpec<K,R>	prefix(java.lang.String prefix) Cannot be invoked if subFlowMapping(Object, IntegrationFlow) is used.
RouterSpec<K,R>	resolutionRequired(boolean resolutionRequired)
RouterSpec<K,R>	subFlowMapping(K key, IntegrationFlow subFlow) Add a subflow as an alternative to a channelMapping(Object, String).
RouterSpec<K,R>	suffix(java.lang.String suffix) Cannot be invoked if subFlowMapping(Object, IntegrationFlow) is used.

Methods inherited from class org.springframework.integration.dsl.AbstractRouterSpec

applySequence, defaultOutputChannel, defaultOutputChannel, defaultOutputToParentFlow, defaultSubFlowMapping, ignoreSendFailures

Methods inherited from class org.springframework.integration.dsl.ConsumerEndpointSpec

advice, async, autoStartup, doGet, notPropagatedHeaders, order, phase, poller, requiresReply, role, sendTimeout, taskScheduler, transactional, transactional, transactional, transactional, transactional

Methods inherited from class org.springframework.integration.dsl.EndpointSpec

assertHandler, id, obtainInputChannelFromFlow, obtainInputChannelFromFlow, poller, poller

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, get, getId, getObject, getObjectType, isSingleton

Methods inherited from class java.lang.Object

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

Method Detail

resolutionRequired

public RouterSpec<K,R> resolutionRequired(boolean resolutionRequired)

Parameters:

resolutionRequired - the resolutionRequired.

Returns:

the router spec.

See Also:

AbstractMappingMessageRouter.setResolutionRequired(boolean)

dynamicChannelLimit

public RouterSpec<K,R> dynamicChannelLimit(int dynamicChannelLimit)

Set a limit for how many dynamic channels are retained (for reporting purposes). When the limit is exceeded, the oldest channel is discarded.

NOTE: this does not affect routing, just the reporting which dynamically resolved channels have been routed to. Default 100.

Parameters:

dynamicChannelLimit - the limit.

Returns:

the router spec.

See Also:

AbstractMappingMessageRouter.setDynamicChannelLimit(int)

prefix

public RouterSpec<K,R> prefix(java.lang.String prefix)

Cannot be invoked if subFlowMapping(Object, IntegrationFlow) is used.

Parameters:

prefix - the prefix.

Returns:

the router spec.

See Also:

AbstractMappingMessageRouter.setPrefix(String)

suffix

public RouterSpec<K,R> suffix(java.lang.String suffix)

Cannot be invoked if subFlowMapping(Object, IntegrationFlow) is used.

Parameters:

suffix - the suffix to set.

Returns:

the router spec.

See Also:

AbstractMappingMessageRouter.setSuffix(String)

channelMapping

public RouterSpec<K,R> channelMapping(K key,
                                      java.lang.String channelName)

Parameters:

key - the key.

channelName - the channelName.

Returns:

the router spec.

See Also:

AbstractMappingMessageRouter.setChannelMapping(String, String)

subFlowMapping

public RouterSpec<K,R> subFlowMapping(K key,
                                      IntegrationFlow subFlow)

Add a subflow as an alternative to a channelMapping(Object, String). prefix(String) and suffix(String) cannot be used when subflow mappings are used.

Parameters:

key - the key.

subFlow - the subFlow.

Returns:

the router spec.

getComponentsToRegister

public java.util.Map<java.lang.Object,java.lang.String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration

Overrides:

getComponentsToRegister in class EndpointSpec<RouterSpec<K,R extends AbstractMappingMessageRouter>,ConsumerEndpointFactoryBean,R extends AbstractMappingMessageRouter>