Class DelayerEndpointSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<DelayerEndpointSpec, reactor.util.function.Tuple2<ConsumerEndpointFactoryBean, DelayHandler>>

org.springframework.integration.dsl.EndpointSpec<DelayerEndpointSpec, ConsumerEndpointFactoryBean, DelayHandler>

org.springframework.integration.dsl.ConsumerEndpointSpec<DelayerEndpointSpec, DelayHandler>

org.springframework.integration.dsl.DelayerEndpointSpec

All Implemented Interfaces:

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

public class DelayerEndpointSpec
extends ConsumerEndpointSpec<DelayerEndpointSpec, DelayHandler>

A ConsumerEndpointSpec for a DelayHandler. The messageGroupId(String) is required option.

Since:

5.0

Author:

Artem Bilan, Gary Russell

See Also:

• DelayHandler

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	DelayerEndpointSpec()
protected	DelayerEndpointSpec(DelayHandler delayHandler)

Method Summary

Modifier and Type	Method	Description
DelayerEndpointSpec	defaultDelay(long defaultDelay)
DelayerEndpointSpec	delayedAdvice(Advice... advice)	Configure a list of Advice objects that will be applied, in nested order, when delayed messages are sent.
DelayerEndpointSpec	delayedMessageErrorChannel(String channel)	Set a message channel name to which an ErrorMessage will be sent if sending the released message fails.
DelayerEndpointSpec	delayedMessageErrorChannel(MessageChannel channel)	Set a message channel to which an ErrorMessage will be sent if sending the released message fails.
DelayerEndpointSpec	delayExpression(String delayExpression)
DelayerEndpointSpec	delayExpression(Expression delayExpression)
<P> DelayerEndpointSpec	delayFunction(Function<Message<P>, Object> delayFunction)	Specify the function to determine delay value against Message.
DelayerEndpointSpec	ignoreExpressionFailures(boolean ignoreExpressionFailures)
DelayerEndpointSpec	maxAttempts(int maxAttempts)	Set the maximum number of release attempts for when message release fails.
DelayerEndpointSpec	messageGroupId(String messageGroupId)	Set a group id to manage delayed messages by this handler.
DelayerEndpointSpec	messageStore(MessageGroupStore messageStore)
DelayerEndpointSpec	retryDelay(long retryDelay)	Set an additional delay to apply when retrying after a release failure.
DelayerEndpointSpec	taskScheduler(TaskScheduler taskScheduler)	Set a provided TaskScheduler into the DelayHandler, as well as call super to set it into an endpoint for this handler (if necessary).
DelayerEndpointSpec	transactionalRelease()	Specify a TransactionInterceptor Advice with default TransactionManager and DefaultTransactionAttribute for the MessageHandler.
DelayerEndpointSpec	transactionalRelease(TransactionInterceptor transactionInterceptor)	Specify a TransactionInterceptor Advice for the MessageHandler.
DelayerEndpointSpec	transactionalRelease(TransactionManager transactionManager)	Specify a TransactionInterceptor Advice with the provided TransactionManager and default DefaultTransactionAttribute for the MessageHandler.

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

advice, async, autoStartup, customizeMonoReply, doGet, handleMessageAdvice, notPropagatedHeaders, order, phase, poller, reactive, reactive, requiresReply, role, sendTimeout, 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

DelayerEndpointSpec

protected DelayerEndpointSpec()

DelayerEndpointSpec

protected DelayerEndpointSpec(DelayHandler delayHandler)

Method Details

defaultDelay

public DelayerEndpointSpec defaultDelay(long defaultDelay)

Parameters:

defaultDelay - the defaultDelay.

Returns:

the endpoint spec.

See Also:

• DelayHandler.setDefaultDelay(long)

ignoreExpressionFailures

public DelayerEndpointSpec ignoreExpressionFailures(boolean ignoreExpressionFailures)

Parameters:

ignoreExpressionFailures - the ignoreExpressionFailures.

Returns:

the endpoint spec.

See Also:

• DelayHandler.setIgnoreExpressionFailures(boolean)

messageStore

public DelayerEndpointSpec messageStore(MessageGroupStore messageStore)

Parameters:

messageStore - the message store.

Returns:

the endpoint spec.

delayedAdvice

public DelayerEndpointSpec delayedAdvice(Advice... advice)

Configure a list of Advice objects that will be applied, in nested order, when delayed messages are sent.

Parameters:

advice - the advice chain.

Returns:

the endpoint spec.

delayExpression

public DelayerEndpointSpec delayExpression(String delayExpression)

delayExpression

public DelayerEndpointSpec delayExpression(Expression delayExpression)

delayedMessageErrorChannel

public DelayerEndpointSpec delayedMessageErrorChannel(MessageChannel channel)

Set a message channel to which an ErrorMessage will be sent if sending the released message fails. If the error flow returns normally, the release is complete. If the error flow throws an exception, the release will be re-attempted. If there is a transaction advice on the release task, the error flow is called within the transaction.

Parameters:

channel - the channel.

Returns:

the endpoint spec.

Since:

5.0.8

See Also:

• maxAttempts(int)
• retryDelay(long)

delayedMessageErrorChannel

public DelayerEndpointSpec delayedMessageErrorChannel(String channel)

Set a message channel name to which an ErrorMessage will be sent if sending the released message fails. If the error flow returns normally, the release is complete. If the error flow throws an exception, the release will be re-attempted. If there is a transaction advice on the release task, the error flow is called within the transaction.

Parameters:

channel - the channel name.

Returns:

the endpoint spec.

Since:

5.0.8

See Also:

• maxAttempts(int)
• retryDelay(long)

maxAttempts

public DelayerEndpointSpec maxAttempts(int maxAttempts)

Set the maximum number of release attempts for when message release fails. Default 5.

Parameters:

maxAttempts - the max attempts.

Returns:

the endpoint spec.

Since:

5.0.8

See Also:

• retryDelay(long)

retryDelay

public DelayerEndpointSpec retryDelay(long retryDelay)

Set an additional delay to apply when retrying after a release failure. Default 1000L.

Parameters:

retryDelay - the retry delay.

Returns:

the endpoint spec.

Since:

5.0.8

See Also:

• maxAttempts(int)

transactionalRelease

public DelayerEndpointSpec transactionalRelease()

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

Returns:

the spec.

Since:

5.0.8

transactionalRelease

public DelayerEndpointSpec transactionalRelease(TransactionInterceptor transactionInterceptor)

Specify a TransactionInterceptor Advice for the MessageHandler.

Parameters:

transactionInterceptor - the TransactionInterceptor to use.

Returns:

the spec.

Since:

5.0.8

See Also:

• TransactionInterceptorBuilder

transactionalRelease

public DelayerEndpointSpec transactionalRelease(TransactionManager transactionManager)

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

Parameters:

transactionManager - the TransactionManager to use.

Returns:

the spec.

Since:

5.2.5

delayFunction

public <P> DelayerEndpointSpec delayFunction(Function<Message<P>, Object> delayFunction)

Specify the function to determine delay value against Message. Typically used with a Java 8 Lambda expression:

 
  .<Foo>delay("delayer", m -> m.getPayload().getDate(),
            c -> c.advice(this.delayedAdvice).messageStore(this.messageStore()))
 
 

Type Parameters:

P - the payload type.

Parameters:

delayFunction - the Function to determine delay.

Returns:

the endpoint spec.

messageGroupId

public DelayerEndpointSpec messageGroupId(String messageGroupId)

Set a group id to manage delayed messages by this handler. Required.

Parameters:

messageGroupId - the group id for delayed messages.

Returns:

the endpoint spec.

Since:

6.2

See Also:

• DelayHandler.setMessageGroupId(String)

taskScheduler

public DelayerEndpointSpec taskScheduler(TaskScheduler taskScheduler)

Set a provided TaskScheduler into the DelayHandler, as well as call super to set it into an endpoint for this handler (if necessary).

Overrides:

taskScheduler in class ConsumerEndpointSpec<DelayerEndpointSpec, DelayHandler>

Parameters:

taskScheduler - the TaskScheduler to use.

Returns:

the spec

See Also:

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