org.springframework.integration.aggregator

Class ResequencingMessageHandler

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.ResequencingMessageHandler

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.core.Ordered, ExpressionCapable, Orderable, MessageProducer, DiscardingMessageHandler, HeaderPropagationAware, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, org.springframework.messaging.MessageHandler

public class ResequencingMessageHandler
extends AbstractCorrelatingMessageHandler

Resequencer specific implementation of AbstractCorrelatingMessageHandler. Will remove MessageGroups only if 'sequenceSize' is provided and reached.

Since:

2.1

Author:

Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

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

AbstractCorrelatingMessageHandler.SequenceAwareMessageGroup

Field Summary

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

messagingTemplate

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

EXPRESSION_PARSER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	afterRelease(MessageGroup messageGroup, java.util.Collection<org.springframework.messaging.Message<?>> completedMessages) Allows you to provide additional logic that needs to be performed after the MessageGroup was released.
protected void	afterRelease(MessageGroup messageGroup, java.util.Collection<org.springframework.messaging.Message<?>> completedMessages, boolean timeout) Subclasses may override if special action is needed because the group was released or discarded due to a timeout.
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
void	setExpireGroupsUponTimeout(boolean expireGroupsUponTimeout) Expire (completely remove) a group if it is completed due to timeout.
protected boolean	shouldCopyRequestHeaders() Subclasses may override this.

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

completeGroup, completeGroup, destroy, expireGroup, findLastReleasedSequenceNumber, forceComplete, getCorrelationStrategy, getDiscardChannel, getDiscardChannelName, getEvaluationContext, getExpireGroupScheduledFutures, getGroupTimeoutExpression, getLockRegistry, getMessageStore, getMinimumTimeoutForEmptyGroups, getOutputProcessor, getReleaseStrategy, handleMessageInternal, isLockRegistrySet, isReleasePartialSequences, isSendPartialResultOnExpiry, isSequenceAware, obtainGroupTimeout, onInit, setApplicationEventPublisher, setCorrelationStrategy, setDiscardChannel, setDiscardChannelName, setForceReleaseAdviceChain, setGroupTimeoutExpression, setIntegrationEvaluationContext, setLockRegistry, setMessageStore, setMinimumTimeoutForEmptyGroups, setReleasePartialSequences, setReleaseStrategy, setSendPartialResultOnExpiry, setTaskScheduler, store, verifyResultCollectionConsistsOfMessages

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

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

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

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

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, 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.context.NamedComponent

getComponentName

Constructor Detail

ResequencingMessageHandler

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

ResequencingMessageHandler

public ResequencingMessageHandler(MessageGroupProcessor processor,
                                  MessageGroupStore store)

ResequencingMessageHandler

public ResequencingMessageHandler(MessageGroupProcessor processor)

Method Detail

setExpireGroupsUponTimeout

public final void setExpireGroupsUponTimeout(boolean expireGroupsUponTimeout)

Expire (completely remove) a group if it is completed due to timeout. Default true (overridden to false for a resequencer so late messages are immediately discarded rather than waiting for the next timeout)

Overrides:

setExpireGroupsUponTimeout in class AbstractCorrelatingMessageHandler

Parameters:

expireGroupsUponTimeout - the expireGroupsUponTimeout to set

getComponentType

public java.lang.String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class AbstractCorrelatingMessageHandler

shouldCopyRequestHeaders

protected boolean shouldCopyRequestHeaders()

Description copied from class: AbstractMessageProducingHandler

Subclasses may override this. True by default.

Overrides:

shouldCopyRequestHeaders in class AbstractMessageProducingHandler

Returns:

true if the request headers should be copied.

afterRelease

protected void afterRelease(MessageGroup messageGroup,
                            java.util.Collection<org.springframework.messaging.Message<?>> completedMessages)

Description copied from class: AbstractCorrelatingMessageHandler

Allows you to provide additional logic that needs to be performed after the MessageGroup was released.

Specified by:

afterRelease in class AbstractCorrelatingMessageHandler

Parameters:

messageGroup - The group.

completedMessages - The completed messages.

afterRelease

protected void afterRelease(MessageGroup messageGroup,
                            java.util.Collection<org.springframework.messaging.Message<?>> completedMessages,
                            boolean timeout)

Description copied from class: AbstractCorrelatingMessageHandler

Subclasses may override if special action is needed because the group was released or discarded due to a timeout. By default, AbstractCorrelatingMessageHandler.afterRelease(MessageGroup, Collection) is invoked.

Overrides:

afterRelease in class AbstractCorrelatingMessageHandler

Parameters:

messageGroup - The group.

completedMessages - The completed messages.

timeout - True if the release/discard was due to a timeout.