org.springframework.integration.aggregator

Class AggregatingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.aggregator.AbstractCorrelatingMessageHandler

org.springframework.integration.aggregator.AggregatingMessageHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Ordered, ExpressionCapable, Orderable, MessageProducer, DiscardingMessageHandler, HeaderPropagationAware, NamedComponent, BaseHandlerMetrics, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class AggregatingMessageHandler
extends AbstractCorrelatingMessageHandler

Aggregator specific implementation of AbstractCorrelatingMessageHandler. Will remove MessageGroups in the afterRelease(org.springframework.integration.store.MessageGroup, java.util.Collection<org.springframework.messaging.Message<?>>) only if 'expireGroupsUponCompletion' flag is set to 'true'.

Since:

2.1

Author:

Oleg Zhurakousky, Artem Bilan, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.aggregator.AbstractCorrelatingMessageHandler

AbstractCorrelatingMessageHandler.SequenceAwareMessageGroup

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AggregatingMessageHandler(MessageGroupProcessor processor)
AggregatingMessageHandler(MessageGroupProcessor processor, MessageGroupStore store)
AggregatingMessageHandler(MessageGroupProcessor processor, MessageGroupStore store, CorrelationStrategy correlationStrategy, ReleaseStrategy releaseStrategy)

Method Summary

Modifier and Type	Method and Description
protected void	afterRelease(MessageGroup messageGroup, Collection<Message<?>> completedMessages) Complete the group and remove all its messages.
protected boolean	isExpireGroupsUponCompletion()
void	setExpireGroupsUponCompletion(boolean expireGroupsUponCompletion) Will set the 'expireGroupsUponCompletion' flag.

Methods inherited from class org.springframework.integration.aggregator.AbstractCorrelatingMessageHandler

afterRelease, completeGroup, completeGroup, destroy, expireGroup, findLastReleasedSequenceNumber, forceComplete, getComponentType, getCorrelationStrategy, getDiscardChannel, getDiscardChannelName, getEvaluationContext, getExpireGroupScheduledFutures, getGroupTimeoutExpression, getLockRegistry, getMessageStore, getMinimumTimeoutForEmptyGroups, getOutputProcessor, getReleaseStrategy, handleMessageInternal, isLockRegistrySet, isReleaseLockBeforeSend, isReleasePartialSequences, isRunning, isSendPartialResultOnExpiry, isSequenceAware, obtainGroupTimeout, onInit, remove, setApplicationEventPublisher, setCorrelationStrategy, setDiscardChannel, setDiscardChannelName, setExpireGroupsUponTimeout, setForceReleaseAdviceChain, setGroupTimeoutExpression, setLockRegistry, setMessageStore, setMinimumTimeoutForEmptyGroups, setOutputProcessor, setPopSequence, setReleaseLockBeforeSend, setReleasePartialSequences, setReleaseStrategy, setSendPartialResultOnExpiry, start, stop, store, verifyResultCollectionConsistsOfMessages

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

configureMetrics, getActiveCount, getActiveCountLong, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMetricsCaptor, getMinDuration, getOrder, getOverrides, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, onComplete, onError, onNext, onSubscribe, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.messaging.MessageHandler

handleMessage

Methods inherited from interface org.springframework.integration.support.management.MessageHandlerMetrics

errorCount, handleCount

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Constructor Detail

AggregatingMessageHandler

public AggregatingMessageHandler(MessageGroupProcessor processor,
                                 MessageGroupStore store,
                                 CorrelationStrategy correlationStrategy,
                                 ReleaseStrategy releaseStrategy)

AggregatingMessageHandler

public AggregatingMessageHandler(MessageGroupProcessor processor,
                                 MessageGroupStore store)

AggregatingMessageHandler

public AggregatingMessageHandler(MessageGroupProcessor processor)

Method Detail

setExpireGroupsUponCompletion

public void setExpireGroupsUponCompletion(boolean expireGroupsUponCompletion)

Will set the 'expireGroupsUponCompletion' flag.

Parameters:

expireGroupsUponCompletion - true when groups should be expired on completion.

See Also:

afterRelease(org.springframework.integration.store.MessageGroup, java.util.Collection<org.springframework.messaging.Message<?>>)

isExpireGroupsUponCompletion

protected boolean isExpireGroupsUponCompletion()

Overrides:

isExpireGroupsUponCompletion in class AbstractCorrelatingMessageHandler

afterRelease

protected void afterRelease(MessageGroup messageGroup,
                            Collection<Message<?>> completedMessages)

Complete the group and remove all its messages. If the expireGroupsUponCompletion is true, then remove group fully.

Specified by:

afterRelease in class AbstractCorrelatingMessageHandler

Parameters:

messageGroup - the group to clean up.

completedMessages - The completed messages. Ignored in this implementation.