Package org.springframework.integration.dsl

Class ConsumerEndpointSpec<S extends ConsumerEndpointSpec<S,H>,H extends MessageHandler>

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,H>

Type Parameters:

S - the target ConsumerEndpointSpec implementation type.

H - the target MessageHandler implementation type.

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractRouterSpec, BarrierSpec, CorrelationHandlerSpec, DelayerEndpointSpec, EnricherSpec, FilterEndpointSpec, GatewayEndpointSpec, GenericEndpointSpec, HeaderEnricherSpec, HeaderFilterSpec, ScatterGatherSpec, SplitterSpec, TransformerEndpointSpec

public abstract class ConsumerEndpointSpec<S extends ConsumerEndpointSpec<S,H>,H extends MessageHandler>
extends EndpointSpec<S,ConsumerEndpointFactoryBean,H>

A EndpointSpec for consumer endpoints.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Advice>	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	ConsumerEndpointSpec(H messageHandler)

Method Summary

Modifier and Type	Method	Description
S	advice(Advice... advice)	Configure a list of Advice objects to be applied, in nested order, to the endpoint's handler.
S	async(boolean async)	Allow async replies.
S	autoStartup(boolean autoStartup)
<T, V> S	customizeMonoReply(BiFunction<Message<?>,reactor.core.publisher.Mono<T>,org.reactivestreams.Publisher<V>> replyCustomizer)	Specify a BiFunction for customizing Mono replies via ReactiveRequestHandlerAdvice.
protected reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,H>	doGet()
S	handleMessageAdvice(MethodInterceptor... interceptors)	Configure a list of MethodInterceptor objects to be applied, in nested order, to the endpoint's handler.
S	notPropagatedHeaders(String... headerPatterns)	Set header patterns ("xxx*", "*xxx", "*xxx*" or "xxx*yyy") that will NOT be copied from the inbound message.
S	order(int order)
S	phase(int phase)
S	poller(PollerMetadata pollerMetadata)
S	reactive()	Make the consumer endpoint as reactive independently of an input channel.
S	reactive(Function<? super reactor.core.publisher.Flux<Message<?>>,? extends org.reactivestreams.Publisher<Message<?>>> reactiveCustomizer)	Make the consumer endpoint as reactive independently of an input channel and apply the provided function into the Flux.transform(Function) operator.
S	requiresReply(boolean requiresReply)
S	role(String role)	Specify the role for the endpoint.
S	sendTimeout(long sendTimeout)
S	taskScheduler(TaskScheduler taskScheduler)	Configure a TaskScheduler for scheduling tasks, for example in the Polling Consumer.
S	transactional()	Specify a TransactionInterceptor Advice with default PlatformTransactionManager and DefaultTransactionAttribute for the MessageHandler.
S	transactional(boolean handleMessageAdvice)	Specify a TransactionInterceptor Advice with default PlatformTransactionManager and DefaultTransactionAttribute for the MessageHandler.
S	transactional(TransactionInterceptor transactionInterceptor)	Specify a TransactionInterceptor Advice for the MessageHandler.
S	transactional(TransactionManager transactionManager)	Specify a TransactionInterceptor Advice with the provided PlatformTransactionManager and default DefaultTransactionAttribute for the MessageHandler.
S	transactional(TransactionManager transactionManager, boolean handleMessageAdvice)	Specify a TransactionInterceptor Advice with the provided PlatformTransactionManager and default DefaultTransactionAttribute for the MessageHandler.

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

Field Details

adviceChain

protected final List<Advice> adviceChain

Constructor Details

ConsumerEndpointSpec

protected ConsumerEndpointSpec(@Nullable
 H messageHandler)

Method Details

phase

public S phase(int phase)

Specified by:

phase in class EndpointSpec<S extends ConsumerEndpointSpec<S,H>,ConsumerEndpointFactoryBean,H extends MessageHandler>

Parameters:

phase - the phase.

Returns:

the endpoint spec.

See Also:

• SmartLifecycle

autoStartup

public S autoStartup(boolean autoStartup)

Specified by:

autoStartup in class EndpointSpec<S extends ConsumerEndpointSpec<S,H>,ConsumerEndpointFactoryBean,H extends MessageHandler>

Parameters:

autoStartup - the autoStartup.

Returns:

the endpoint spec

See Also:

• SmartLifecycle

poller

public S poller(PollerMetadata pollerMetadata)

Specified by:

poller in class EndpointSpec<S extends ConsumerEndpointSpec<S,H>,ConsumerEndpointFactoryBean,H extends MessageHandler>

Parameters:

pollerMetadata - the pollerMetadata

Returns:

the endpoint spec.

See Also:

• AbstractPollingEndpoint

reactive

public S reactive()

Make the consumer endpoint as reactive independently of an input channel.

Returns:

the spec

Since:

5.5

reactive

public S reactive(Function<? super reactor.core.publisher.Flux<Message<?>>,? extends org.reactivestreams.Publisher<Message<?>>> reactiveCustomizer)

Make the consumer endpoint as reactive independently of an input channel and apply the provided function into the Flux.transform(Function) operator.

Parameters:

reactiveCustomizer - the function to transform Flux for the input channel.

Returns:

the spec

Since:

5.5

role

public S role(String role)

Description copied from class: EndpointSpec

Specify the role for the endpoint. Such endpoints can be started/stopped as a group.

Specified by:

role in class EndpointSpec<S extends ConsumerEndpointSpec<S,H>,ConsumerEndpointFactoryBean,H extends MessageHandler>

Parameters:

role - the role for this endpoint.

Returns:

the endpoint spec

See Also:

• SmartLifecycle
• SmartLifecycleRoleController

taskScheduler

public S taskScheduler(TaskScheduler taskScheduler)

Configure a TaskScheduler for scheduling tasks, for example in the Polling Consumer. By default, the global ThreadPoolTaskScheduler bean is used. This configuration is useful when there are requirements to dedicate particular threads for polling task, for example.

Parameters:

taskScheduler - the TaskScheduler to use.

Returns:

the endpoint spec.

See Also:

• IntegrationContextUtils.getTaskScheduler(org.springframework.beans.factory.BeanFactory)

handleMessageAdvice

public S handleMessageAdvice(MethodInterceptor... interceptors)

Configure a list of MethodInterceptor objects to be applied, in nested order, to the endpoint's handler. The advice objects are applied to the handleMessage() method and therefore to the whole sub-flow afterward.

Parameters:

interceptors - the advice chain.

Returns:

the endpoint spec.

Since:

5.3

advice

public S advice(Advice... advice)

Configure a list of Advice objects to be applied, in nested order, to the endpoint's handler. The advice objects are applied only to the handler.

Parameters:

advice - the advice chain.

Returns:

the endpoint spec.

transactional

public S transactional(TransactionManager transactionManager)

Specify a TransactionInterceptor Advice with the provided PlatformTransactionManager and default DefaultTransactionAttribute for the MessageHandler.

Parameters:

transactionManager - the TransactionManager to use.

Returns:

the spec.

transactional

public S transactional(TransactionManager transactionManager,
 boolean handleMessageAdvice)

Specify a TransactionInterceptor Advice with the provided PlatformTransactionManager and default DefaultTransactionAttribute for the MessageHandler.

Parameters:

transactionManager - the TransactionManager to use.

handleMessageAdvice - the flag to indicate the target Advice type: false - regular TransactionInterceptor; true - TransactionHandleMessageAdvice extension.

Returns:

the spec.

transactional

public S transactional(TransactionInterceptor transactionInterceptor)

Specify a TransactionInterceptor Advice for the MessageHandler.

Parameters:

transactionInterceptor - the TransactionInterceptor to use.

Returns:

the spec.

See Also:

• TransactionInterceptorBuilder

transactional

public S transactional()

Specify a TransactionInterceptor Advice with default PlatformTransactionManager and DefaultTransactionAttribute for the MessageHandler.

Returns:

the spec.

transactional

public S transactional(boolean handleMessageAdvice)

Specify a TransactionInterceptor Advice with default PlatformTransactionManager and DefaultTransactionAttribute for the MessageHandler.

Parameters:

handleMessageAdvice - the flag to indicate the target Advice type: false - regular TransactionInterceptor; true - TransactionHandleMessageAdvice extension.

Returns:

the spec.

customizeMonoReply

public <T,
V> S customizeMonoReply(BiFunction<Message<?>,reactor.core.publisher.Mono<T>,org.reactivestreams.Publisher<V>> replyCustomizer)

Specify a BiFunction for customizing Mono replies via ReactiveRequestHandlerAdvice.

Type Parameters:

T - inbound reply payload.

V - outbound reply payload.

Parameters:

replyCustomizer - the BiFunction to propagate into ReactiveRequestHandlerAdvice.

Returns:

the spec.

Since:

5.3

See Also:

• ReactiveRequestHandlerAdvice

requiresReply

public S requiresReply(boolean requiresReply)

Parameters:

requiresReply - the requiresReply.

Returns:

the endpoint spec.

See Also:

• AbstractReplyProducingMessageHandler.setRequiresReply(boolean)

sendTimeout

public S sendTimeout(long sendTimeout)

Parameters:

sendTimeout - the send timeout.

Returns:

the endpoint spec.

See Also:

• AbstractMessageProducingHandler.setSendTimeout(long)

order

public S order(int order)

Parameters:

order - the order.

Returns:

the endpoint spec.

See Also:

• MessageHandlerSupport.setOrder(int)

async

public S async(boolean async)

Allow async replies. If the handler reply is a CompletableFuture, send the output when it is satisfied rather than sending the future as the result. Ignored for handler return types other than CompletableFuture.

Parameters:

async - true to allow.

Returns:

the endpoint spec.

See Also:

• AbstractMessageProducingHandler.setAsync(boolean)

notPropagatedHeaders

public S notPropagatedHeaders(String... headerPatterns)

Set header patterns ("xxx*", "*xxx", "*xxx*" or "xxx*yyy") that will NOT be copied from the inbound message. At least one pattern as "*" means do not copy headers at all.

Parameters:

headerPatterns - the headers to not propagate from the inbound message.

Returns:

the endpoint spec.

See Also:

• AbstractMessageProducingHandler.setNotPropagatedHeaders(String...)

doGet

protected reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,H> doGet()

Overrides:

doGet in class EndpointSpec<S extends ConsumerEndpointSpec<S,H>,ConsumerEndpointFactoryBean,H extends MessageHandler>