Package org.springframework.integration.dsl

Class SplitterSpec

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<SplitterSpec,AbstractMessageSplitter>

org.springframework.integration.dsl.SplitterSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,AbstractMessageSplitter>>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public class SplitterSpec
extends ConsumerEndpointSpec<SplitterSpec,AbstractMessageSplitter>

A ConsumerEndpointSpec for an AbstractMessageSplitter.

Since:

6.2

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

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SplitterSpec()

Method Summary

Modifier and Type	Method	Description
SplitterSpec	applySequence(boolean applySequence)	Set the applySequence flag to the specified value.
SplitterSpec	delimiters(String delimiters)	Set delimiters to tokenize String values.
SplitterSpec	discardChannel(String discardChannelName)	Specify a channel bean name where rejected Messages should be sent.
SplitterSpec	discardChannel(MessageChannel discardChannel)	Specify a channel where rejected Messages should be sent.
SplitterSpec	discardFlow(IntegrationFlow discardFlow)	Configure a subflow to run for discarded messages instead of a discardChannel(MessageChannel).
reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,AbstractMessageSplitter>	doGet()
SplitterSpec	expectedType(Class<?> expectedType)	Set a Function input argument type.
SplitterSpec	expression(String expression)	Provide an expression to use an ExpressionEvaluatingSplitter for the target handler.
SplitterSpec	expression(Expression expression)	Provide an expression to use an ExpressionEvaluatingSplitter for the target handler.
<P> SplitterSpec	function(Function<P,?> function)	Provide a Function as a direct delegate for MethodInvokingSplitter.
SplitterSpec	method(String method)	Provide a service method name to call.
SplitterSpec	ref(Object ref)	Provide a service to use a MethodInvokingSplitter for the target handler.
SplitterSpec	refName(String refName)	Provide a bean name to use a MethodInvokingSplitter (based on BeanNameMessageProcessor) for the target handler.

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

advice, async, autoStartup, customizeMonoReply, handleMessageAdvice, notPropagatedHeaders, order, phase, poller, reactive, reactive, requiresReply, role, sendTimeout, taskScheduler, transactional, transactional, transactional, transactional, transactional

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

assertHandler, getComponentsToRegister, id, obtainInputChannelFromFlow, obtainInputChannelFromFlow, poller, poller

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

_this, afterPropertiesSet, destroy, getId, getObject, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Constructor Details

SplitterSpec

protected SplitterSpec()

Method Details

delimiters

public SplitterSpec delimiters(String delimiters)

Set delimiters to tokenize String values. The default is null indicating that no tokenizing should occur. If delimiters are provided, they will be applied to any String payload. Only applied if provided splitter is instance of DefaultMessageSplitter.

Parameters:

delimiters - The delimiters.

Returns:

the endpoint spec.

See Also:

• DefaultMessageSplitter.setDelimiters(String)

expression

public SplitterSpec expression(String expression)

Provide an expression to use an ExpressionEvaluatingSplitter for the target handler.

Parameters:

expression - the SpEL expression to use.

Returns:

the spec

expression

public SplitterSpec expression(Expression expression)

Provide an expression to use an ExpressionEvaluatingSplitter for the target handler.

Parameters:

expression - the SpEL expression to use.

Returns:

the spec

ref

public SplitterSpec ref(Object ref)

Provide a service to use a MethodInvokingSplitter for the target handler. This option can be set to an AbstractMessageSplitter implementation, a MessageHandlerSpec providing an AbstractMessageSplitter, or MessageProcessorSpec.

Parameters:

ref - the service to call as a splitter POJO.

Returns:

the spec

refName

public SplitterSpec refName(String refName)

Provide a bean name to use a MethodInvokingSplitter (based on BeanNameMessageProcessor) for the target handler.

Parameters:

refName - the bean name for service to call as a splitter POJO.

Returns:

the spec

method

public SplitterSpec method(@Nullable
 String method)

Provide a service method name to call. Optional. Use only together with ref(Object) or refName(String).

Parameters:

method - the service method name to call.

Returns:

the spec

function

public <P> SplitterSpec function(Function<P,?> function)

Provide a Function as a direct delegate for MethodInvokingSplitter.

Type Parameters:

P - the input type.

Parameters:

function - the Function instance to use.

Returns:

the spec

expectedType

public SplitterSpec expectedType(@Nullable
 Class<?> expectedType)

Set a Function input argument type. Can be a Message. Ignored for all other options, but function(Function).

Parameters:

expectedType - the Function input argument type.

Returns:

the spec.

applySequence

public SplitterSpec applySequence(boolean applySequence)

Set the applySequence flag to the specified value. Defaults to true.

Parameters:

applySequence - the applySequence.

Returns:

the endpoint spec.

See Also:

• AbstractMessageSplitter.setApplySequence(boolean)

discardChannel

public SplitterSpec discardChannel(MessageChannel discardChannel)

Specify a channel where rejected Messages should be sent. If the discard channel is null (the default), rejected Messages will be dropped. A "Rejected Message" means that split function has returned an empty result (but not null): no items to iterate for sending.

Parameters:

discardChannel - The discard channel.

Returns:

the endpoint spec.

See Also:

• DefaultMessageSplitter.setDelimiters(String)

discardFlow

public SplitterSpec discardFlow(IntegrationFlow discardFlow)

Configure a subflow to run for discarded messages instead of a discardChannel(MessageChannel).

Parameters:

discardFlow - the discard flow.

Returns:

the endpoint spec.

discardChannel

public SplitterSpec discardChannel(String discardChannelName)

Specify a channel bean name where rejected Messages should be sent. If the discard channel is null (the default), rejected Messages will be dropped. A "Rejected Message" means that split function has returned an empty result (but not null): no items to iterate for sending.

Parameters:

discardChannelName - The discard channel bean name.

Returns:

the endpoint spec.

See Also:

• DefaultMessageSplitter.setDelimiters(String)

doGet

public reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,AbstractMessageSplitter> doGet()

Overrides:

doGet in class ConsumerEndpointSpec<SplitterSpec,AbstractMessageSplitter>