org.springframework.integration.dsl

Class SplitterEndpointSpec<S extends AbstractMessageSplitter>

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

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<SplitterEndpointSpec<S>,S>

org.springframework.integration.dsl.SplitterEndpointSpec<S>

Type Parameters:

S - the target SplitterEndpointSpec implementation type.

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,S>>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public final class SplitterEndpointSpec<S extends AbstractMessageSplitter>
extends ConsumerEndpointSpec<SplitterEndpointSpec<S>,S>

A ConsumerEndpointSpec for a AbstractMessageSplitter implementations.

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

PARSER, target

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

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

OBJECT_TYPE_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
SplitterEndpointSpec<S>	applySequence(boolean applySequence) Set the applySequence flag to the specified value.
SplitterEndpointSpec<S>	delimiters(String delimiters) Set delimiters to tokenize String values.
SplitterEndpointSpec<S>	discardChannel(MessageChannel discardChannel) Specify a channel where rejected Messages should be sent.
SplitterEndpointSpec<S>	discardChannel(String discardChannelName) Specify a channel bean name where rejected Messages should be sent.
SplitterEndpointSpec<S>	discardFlow(IntegrationFlow discardFlow) Configure a subflow to run for discarded messages instead of a discardChannel(MessageChannel).

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, getComponentsToRegister, id, obtainInputChannelFromFlow, obtainInputChannelFromFlow, poller, poller

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

_this, createInstance, destroyInstance, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Method Detail

applySequence

public SplitterEndpointSpec<S> 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)

delimiters

public SplitterEndpointSpec<S> 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)

discardChannel

public SplitterEndpointSpec<S> 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.

Since:

5.2

See Also:

DefaultMessageSplitter.setDelimiters(String)

discardChannel

public SplitterEndpointSpec<S> 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.

Since:

5.2

See Also:

DefaultMessageSplitter.setDelimiters(String)

discardFlow

public SplitterEndpointSpec<S> 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.

Since:

5.2