Package org.springframework.integration.dsl

Class AggregatorSpec

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>

org.springframework.integration.dsl.CorrelationHandlerSpec<AggregatorSpec,AggregatingMessageHandler>

org.springframework.integration.dsl.AggregatorSpec

All Implemented Interfaces:

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

public class AggregatorSpec
extends CorrelationHandlerSpec<AggregatorSpec,AggregatingMessageHandler>

A CorrelationHandlerSpec for an AggregatingMessageHandler.

Since:

5.0

Author:

Artem Bilan, Ngoc Nhan

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	AggregatorSpec()

Method Summary

Modifier and Type	Method	Description
AggregatorSpec	expireGroupsUponCompletion(boolean expireGroupsUponCompletion)
Map<Object,String>	getComponentsToRegister()
AggregatorSpec	headersFunction(Function<MessageGroup,Map<String,Object>> headersFunction)	Configure a Function to merge and compute headers for reply based on the completed MessageGroup.
AggregatorSpec	outputExpression(String expression)	An expression to determine the output message from the released group.
AggregatorSpec	outputProcessor(MessageGroupProcessor outputProcessor)	A processor to determine the output message from the released group.
AggregatorSpec	processor(Object target)	Configure the handler with MethodInvokingCorrelationStrategy and MethodInvokingReleaseStrategy using the target object which should have methods annotated appropriately for each function.
AggregatorSpec	processor(Object target, String methodName)	Configure the handler with MethodInvokingCorrelationStrategy and MethodInvokingReleaseStrategy using the target object which should have methods annotated appropriately for each function.

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

correlationExpression, correlationStrategy, correlationStrategy, discardChannel, discardChannel, expireDuration, expireGroupsUponTimeout, expireTimeout, forceReleaseAdvice, groupConditionSupplier, groupTimeout, groupTimeout, groupTimeoutExpression, lockRegistry, messageStore, minimumTimeoutForEmptyGroups, popSequence, releaseExpression, releaseLockBeforeSend, releaseStrategy, releaseStrategy, sendPartialResultOnExpiry, taskScheduler

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

AggregatorSpec

protected AggregatorSpec()

Method Details

processor

public AggregatorSpec processor(Object target)

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

Overrides:

processor in class CorrelationHandlerSpec<AggregatorSpec,AggregatingMessageHandler>

Parameters:

target - the target object.

Returns:

the handler spec.

See Also:

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

processor

public AggregatorSpec processor(Object target,
 @Nullable
 String methodName)

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

Parameters:

target - the target object.

methodName - The method name for the output processor (or 'null' in which case, the target object must have an Aggregator annotation).

Returns:

the handler spec.

outputExpression

public AggregatorSpec outputExpression(String expression)

An expression to determine the output message from the released group. Defaults to a message with a payload that is a collection of payloads from the input messages.

Parameters:

expression - the expression.

Returns:

the aggregator spec.

outputProcessor

public AggregatorSpec outputProcessor(MessageGroupProcessor outputProcessor)

A processor to determine the output message from the released group. Defaults to a message with a payload that is a collection of payloads from the input messages.

Parameters:

outputProcessor - the processor.

Returns:

the aggregator spec.

expireGroupsUponCompletion

public AggregatorSpec expireGroupsUponCompletion(boolean expireGroupsUponCompletion)

Parameters:

expireGroupsUponCompletion - the expireGroupsUponCompletion.

Returns:

the aggregator spec.

See Also:

• AggregatingMessageHandler.setExpireGroupsUponCompletion(boolean)

headersFunction

public AggregatorSpec headersFunction(Function<MessageGroup,Map<String,Object>> headersFunction)

Configure a Function to merge and compute headers for reply based on the completed MessageGroup.

Parameters:

headersFunction - the Function to merge and compute headers for reply based on the completed MessageGroup.

Returns:

the aggregator spec.

Since:

5.2

getComponentsToRegister

public Map<Object,String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration

Overrides:

getComponentsToRegister in class EndpointSpec<AggregatorSpec,ConsumerEndpointFactoryBean,AggregatingMessageHandler>