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:

FactoryBean<reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,H>>, ComponentsRegistration

Direct Known Subclasses:

AbstractRouterSpec, BarrierSpec, CorrelationHandlerSpec, DelayerEndpointSpec, EnricherSpec, FilterEndpointSpec, GatewayEndpointSpec, GenericEndpointSpec, HeaderEnricherSpec, ScatterGatherSpec, SplitterEndpointSpec

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 and Description
protected 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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConsumerEndpointSpec(H messageHandler)

Method Summary

Modifier and Type	Method and 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)
protected reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,H>	doGet()
S	order(int order)
S	phase(int phase)
S	poller(PollerMetadata pollerMetadata)
S	requiresReply(boolean requiresReply)
S	sendTimeout(long sendTimeout)
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(PlatformTransactionManager transactionManager) Specify a TransactionInterceptor Advice with the provided PlatformTransactionManager and default DefaultTransactionAttribute for the MessageHandler.
S	transactional(PlatformTransactionManager transactionManager, boolean handleMessageAdvice) Specify a TransactionInterceptor Advice with the provided PlatformTransactionManager and default DefaultTransactionAttribute for the MessageHandler.
S	transactional(TransactionInterceptor transactionInterceptor) Specify a TransactionInterceptor Advice for the MessageHandler.

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

assertHandler, getComponentsToRegister, id, 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

Field Detail

adviceChain

protected final List<Advice> adviceChain

Constructor Detail

ConsumerEndpointSpec

protected ConsumerEndpointSpec(H messageHandler)

Method Detail

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

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(PlatformTransactionManager transactionManager)

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

Parameters:

transactionManager - the PlatformTransactionManager to use.

Returns:

the spec.

transactional

public S transactional(PlatformTransactionManager transactionManager,
                       boolean handleMessageAdvice)

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

Parameters:

transactionManager - the PlatformTransactionManager 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.

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:

AbstractMessageHandler.setOrder(int)

async

public S async(boolean async)

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

Parameters:

async - true to allow.

Returns:

the endpoint spec.

See Also:

AbstractMessageProducingHandler.setAsync(boolean)

doGet

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

Overrides:

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