org.springframework.integration.dsl

Class CorrelationHandlerSpec<S extends CorrelationHandlerSpec<S,H>,H extends org.springframework.integration.aggregator.AbstractCorrelatingMessageHandler>

java.lang.Object

org.springframework.integration.dsl.core.IntegrationComponentSpec<S,Tuple2<F,H>>

org.springframework.integration.dsl.core.EndpointSpec<S,org.springframework.integration.config.ConsumerEndpointFactoryBean,H>

org.springframework.integration.dsl.core.ConsumerEndpointSpec<S,H>

org.springframework.integration.dsl.CorrelationHandlerSpec<S,H>

Type Parameters:

S - the target CorrelationHandlerSpec implementation type.

H - the AbstractCorrelatingMessageHandler implementation type.

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<Tuple2<org.springframework.integration.config.ConsumerEndpointFactoryBean,H>>, ComponentsRegistration

Direct Known Subclasses:

AggregatorSpec, ResequencerSpec

public abstract class CorrelationHandlerSpec<S extends CorrelationHandlerSpec<S,H>,H extends org.springframework.integration.aggregator.AbstractCorrelatingMessageHandler>
extends ConsumerEndpointSpec<S,H>

A MessageHandlerSpec for an AbstractCorrelatingMessageHandler.

Author:

Artem Bilan

Field Summary

Fields inherited from class org.springframework.integration.dsl.core.ConsumerEndpointSpec

adviceChain

Fields inherited from class org.springframework.integration.dsl.core.EndpointSpec

componentToRegister, endpointFactoryBean, handler

Fields inherited from class org.springframework.integration.dsl.core.IntegrationComponentSpec

logger, PARSER, target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CorrelationHandlerSpec(H messageHandler)

Method Summary

Modifier and Type	Method and Description
S	correlationExpression(java.lang.String correlationExpression) Configure the handler with an ExpressionEvaluatingCorrelationStrategy for the given expression.
S	correlationStrategy(org.springframework.integration.aggregator.CorrelationStrategy correlationStrategy)
S	correlationStrategy(java.lang.Object target, java.lang.String methodName) Configure the handler with an MethodInvokingCorrelationStrategy for the target object and method name.
S	discardChannel(org.springframework.messaging.MessageChannel discardChannel)
S	discardChannel(java.lang.String discardChannelName)
S	expireGroupsUponTimeout(boolean expireGroupsUponTimeout) Expire (completely remove) a group if it is completed due to timeout.
S	forceReleaseAdvice(org.aopalliance.aop.Advice... advice) Configure a list of Advice objects to be applied to the forceComplete() operation.
S	groupTimeout(Function<org.springframework.integration.store.MessageGroup,java.lang.Long> groupTimeoutFunction) Configure the handler with a function that will be invoked to resolve the group timeout, based on the message group.
S	groupTimeout(long groupTimeout) Configure the handler with a group timeout expression that evaluates to this constant value.
S	groupTimeoutExpression(java.lang.String groupTimeoutExpression)
S	lockRegistry(org.springframework.integration.support.locks.LockRegistry lockRegistry) Used to obtain a Lock based on the groupId for concurrent operations on the MessageGroup.
S	messageStore(org.springframework.integration.store.MessageGroupStore messageStore)
S	minimumTimeoutForEmptyGroups(long minimumTimeoutForEmptyGroups)
S	processor(java.lang.Object target) Configure the handler with MethodInvokingCorrelationStrategy and MethodInvokingReleaseStrategy using the target object which should have methods annotated appropriately for each function.
S	releaseExpression(java.lang.String releaseExpression) Configure the handler with an ExpressionEvaluatingReleaseStrategy for the given expression.
S	releaseStrategy(java.lang.Object target, java.lang.String methodName) Configure the handler with an MethodInvokingReleaseStrategy for the target object and method name.
S	releaseStrategy(org.springframework.integration.aggregator.ReleaseStrategy releaseStrategy)
S	sendPartialResultOnExpiry(boolean sendPartialResultOnExpiry)
S	taskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)

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

advice, async, autoStartup, order, phase, poller, requiresReply, sendTimeout, transactional, transactional, transactional, transactional, transactional

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

assertHandler, doGet, getComponentsToRegister, id, poller, poller

Methods inherited from class org.springframework.integration.dsl.core.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

Constructor Detail

CorrelationHandlerSpec

protected CorrelationHandlerSpec(H messageHandler)

Method Detail

messageStore

public S messageStore(org.springframework.integration.store.MessageGroupStore messageStore)

Parameters:

messageStore - the message group store.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setMessageStore(MessageGroupStore)

sendPartialResultOnExpiry

public S sendPartialResultOnExpiry(boolean sendPartialResultOnExpiry)

Parameters:

sendPartialResultOnExpiry - the sendPartialResultOnExpiry.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setSendPartialResultOnExpiry(boolean)

minimumTimeoutForEmptyGroups

public S minimumTimeoutForEmptyGroups(long minimumTimeoutForEmptyGroups)

Parameters:

minimumTimeoutForEmptyGroups - the minimumTimeoutForEmptyGroups

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setMinimumTimeoutForEmptyGroups(long)

groupTimeout

public S groupTimeout(long groupTimeout)

Configure the handler with a group timeout expression that evaluates to this constant value.

Parameters:

groupTimeout - the group timeout in milliseconds.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setGroupTimeoutExpression(org.springframework.expression.Expression), ValueExpression

groupTimeoutExpression

public S groupTimeoutExpression(java.lang.String groupTimeoutExpression)

Parameters:

groupTimeoutExpression - the group timeout expression string.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setGroupTimeoutExpression(org.springframework.expression.Expression)

groupTimeout

public S groupTimeout(Function<org.springframework.integration.store.MessageGroup,java.lang.Long> groupTimeoutFunction)

Configure the handler with a function that will be invoked to resolve the group timeout, based on the message group. Usually used with a JDK8 lambda:

.groupTimeout(g -> g.size() * 2000L).

Parameters:

groupTimeoutFunction - a function invoked to resolve the group timeout in milliseconds.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setGroupTimeoutExpression(org.springframework.expression.Expression)

taskScheduler

public S taskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)

Parameters:

taskScheduler - the task scheduler.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setTaskScheduler(TaskScheduler)

discardChannel

public S discardChannel(org.springframework.messaging.MessageChannel discardChannel)

Parameters:

discardChannel - the discard channel.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setDiscardChannel(MessageChannel)

discardChannel

public S discardChannel(java.lang.String discardChannelName)

Parameters:

discardChannelName - the discard channel.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setDiscardChannelName(String)

processor

public S processor(java.lang.Object target)

Configure the handler with MethodInvokingCorrelationStrategy and MethodInvokingReleaseStrategy using the target object which should have methods annotated appropriately for each function.

Parameters:

target - the target object,

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setCorrelationStrategy(CorrelationStrategy), AbstractCorrelatingMessageHandler.setReleaseStrategy(ReleaseStrategy)

correlationExpression

public S correlationExpression(java.lang.String correlationExpression)

Configure the handler with an ExpressionEvaluatingCorrelationStrategy for the given expression.

Parameters:

correlationExpression - the correlation expression.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setCorrelationStrategy(CorrelationStrategy)

correlationStrategy

public S correlationStrategy(java.lang.Object target,
                             java.lang.String methodName)

Configure the handler with an MethodInvokingCorrelationStrategy for the target object and method name.

Parameters:

target - the target object.

methodName - the method name.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setCorrelationStrategy(CorrelationStrategy)

correlationStrategy

public S correlationStrategy(org.springframework.integration.aggregator.CorrelationStrategy correlationStrategy)

Parameters:

correlationStrategy - the correlation strategy.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setCorrelationStrategy(CorrelationStrategy)

releaseExpression

public S releaseExpression(java.lang.String releaseExpression)

Configure the handler with an ExpressionEvaluatingReleaseStrategy for the given expression.

Parameters:

releaseExpression - the correlation expression.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setReleaseStrategy(ReleaseStrategy)

releaseStrategy

public S releaseStrategy(java.lang.Object target,
                         java.lang.String methodName)

Configure the handler with an MethodInvokingReleaseStrategy for the target object and method name.

Parameters:

target - the target object.

methodName - the method name.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setReleaseStrategy(ReleaseStrategy)

releaseStrategy

public S releaseStrategy(org.springframework.integration.aggregator.ReleaseStrategy releaseStrategy)

Parameters:

releaseStrategy - the release strategy.

Returns:

the handler spec.

See Also:

AbstractCorrelatingMessageHandler.setReleaseStrategy(ReleaseStrategy)

expireGroupsUponTimeout

public S expireGroupsUponTimeout(boolean expireGroupsUponTimeout)

Expire (completely remove) a group if it is completed due to timeout. Default true for aggregator and false for resequencer.

Parameters:

expireGroupsUponTimeout - the expireGroupsUponTimeout to set

Returns:

the handler spec.

Since:

1.1

See Also:

AbstractCorrelatingMessageHandler.setExpireGroupsUponTimeout(boolean)

forceReleaseAdvice

public S forceReleaseAdvice(org.aopalliance.aop.Advice... advice)

Configure a list of Advice objects to be applied to the forceComplete() operation.

Parameters:

advice - the advice chain.

Returns:

the endpoint spec.

Since:

1.1

lockRegistry

public S lockRegistry(org.springframework.integration.support.locks.LockRegistry lockRegistry)

Used to obtain a Lock based on the groupId for concurrent operations on the MessageGroup. By default, an internal DefaultLockRegistry is used. Use of a distributed LockRegistry, such as the RedisLockRegistry, ensures only one instance of the aggregator will operate on a group concurrently.

Parameters:

lockRegistry - the LockRegistry to use.

Returns:

the endpoint spec.

Since:

1.1