public abstract class AbstractCorrelatingMessageHandler extends AbstractMessageProducingHandler implements DiscardingMessageHandler, DisposableBean, ApplicationEventPublisherAware
MessageStore
. This class takes care of correlated groups of messages
that can be completed in batches. It is useful for custom implementation of
MessageHandlers that require correlation and is used as a base class for Aggregator -
AggregatingMessageHandler
and Resequencer - ResequencingMessageHandler
,
or custom implementations requiring correlation.
To customize this handler inject CorrelationStrategy
,
ReleaseStrategy
, and MessageGroupProcessor
implementations as
you require.
By default the CorrelationStrategy
will be a
HeaderAttributeCorrelationStrategy
and the ReleaseStrategy
will be a
SequenceSizeReleaseStrategy
.
Modifier and Type | Class and Description |
---|---|
protected static class |
AbstractCorrelatingMessageHandler.SequenceAwareMessageGroup |
messagingTemplate
EXPRESSION_PARSER
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor and Description |
---|
AbstractCorrelatingMessageHandler(MessageGroupProcessor processor) |
AbstractCorrelatingMessageHandler(MessageGroupProcessor processor,
MessageGroupStore store) |
AbstractCorrelatingMessageHandler(MessageGroupProcessor processor,
MessageGroupStore store,
CorrelationStrategy correlationStrategy,
ReleaseStrategy releaseStrategy) |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
afterRelease(MessageGroup group,
Collection<Message<?>> completedMessages)
Allows you to provide additional logic that needs to be performed after the MessageGroup was released.
|
protected void |
afterRelease(MessageGroup group,
Collection<Message<?>> completedMessages,
boolean timeout)
Subclasses may override if special action is needed because the group was released or discarded
due to a timeout.
|
protected Collection<Message<?>> |
completeGroup(Message<?> message,
Object correlationKey,
MessageGroup group) |
protected void |
completeGroup(Object correlationKey,
MessageGroup group) |
void |
destroy() |
protected void |
expireGroup(Object correlationKey,
MessageGroup group) |
protected int |
findLastReleasedSequenceNumber(Object groupId,
Collection<Message<?>> partialSequence) |
protected void |
forceComplete(MessageGroup group) |
String |
getComponentType()
Subclasses may implement this method to provide component type information.
|
protected CorrelationStrategy |
getCorrelationStrategy() |
MessageChannel |
getDiscardChannel()
Return the discard channel.
|
protected String |
getDiscardChannelName() |
protected EvaluationContext |
getEvaluationContext() |
protected Map<UUID,ScheduledFuture<?>> |
getExpireGroupScheduledFutures() |
protected Expression |
getGroupTimeoutExpression() |
protected LockRegistry |
getLockRegistry() |
MessageGroupStore |
getMessageStore() |
protected long |
getMinimumTimeoutForEmptyGroups() |
protected MessageGroupProcessor |
getOutputProcessor() |
protected ReleaseStrategy |
getReleaseStrategy() |
protected void |
handleMessageInternal(Message<?> message) |
protected boolean |
isLockRegistrySet() |
protected boolean |
isReleasePartialSequences() |
protected boolean |
isSendPartialResultOnExpiry() |
protected boolean |
isSequenceAware() |
protected Long |
obtainGroupTimeout(MessageGroup group) |
protected void |
onInit()
Subclasses may implement this for initialization logic.
|
void |
setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) |
void |
setCorrelationStrategy(CorrelationStrategy correlationStrategy) |
void |
setDiscardChannel(MessageChannel discardChannel) |
void |
setDiscardChannelName(String discardChannelName) |
void |
setExpireGroupsUponTimeout(boolean expireGroupsUponTimeout)
Expire (completely remove) a group if it is completed due to timeout.
|
void |
setForceReleaseAdviceChain(List<Advice> forceReleaseAdviceChain) |
void |
setGroupTimeoutExpression(Expression groupTimeoutExpression) |
void |
setIntegrationEvaluationContext(EvaluationContext evaluationContext) |
void |
setLockRegistry(LockRegistry lockRegistry) |
void |
setMessageStore(MessageGroupStore store) |
void |
setMinimumTimeoutForEmptyGroups(long minimumTimeoutForEmptyGroups)
By default, when a MessageGroupStoreReaper is configured to expire partial
groups, empty groups are also removed.
|
void |
setReleasePartialSequences(boolean releasePartialSequences)
Set
releasePartialSequences on an underlying
SequenceSizeReleaseStrategy . |
void |
setReleaseStrategy(ReleaseStrategy releaseStrategy) |
void |
setSendPartialResultOnExpiry(boolean sendPartialResultOnExpiry) |
void |
setTaskScheduler(TaskScheduler taskScheduler) |
protected MessageGroup |
store(Object correlationKey,
Message<?> message) |
protected void |
verifyResultCollectionConsistsOfMessages(Collection<?> elements) |
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput
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
afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
handleMessage
getComponentName
public AbstractCorrelatingMessageHandler(MessageGroupProcessor processor, MessageGroupStore store, CorrelationStrategy correlationStrategy, ReleaseStrategy releaseStrategy)
public AbstractCorrelatingMessageHandler(MessageGroupProcessor processor, MessageGroupStore store)
public AbstractCorrelatingMessageHandler(MessageGroupProcessor processor)
public void setLockRegistry(LockRegistry lockRegistry)
public final void setMessageStore(MessageGroupStore store)
public void setCorrelationStrategy(CorrelationStrategy correlationStrategy)
public void setReleaseStrategy(ReleaseStrategy releaseStrategy)
public void setGroupTimeoutExpression(Expression groupTimeoutExpression)
public void setForceReleaseAdviceChain(List<Advice> forceReleaseAdviceChain)
public void setIntegrationEvaluationContext(EvaluationContext evaluationContext)
public void setTaskScheduler(TaskScheduler taskScheduler)
setTaskScheduler
in class IntegrationObjectSupport
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
setApplicationEventPublisher
in interface ApplicationEventPublisherAware
protected void onInit() throws Exception
IntegrationObjectSupport
onInit
in class AbstractMessageProducingHandler
Exception
- Any exception.public void setDiscardChannel(MessageChannel discardChannel)
public void setDiscardChannelName(String discardChannelName)
public void setSendPartialResultOnExpiry(boolean sendPartialResultOnExpiry)
public void setMinimumTimeoutForEmptyGroups(long minimumTimeoutForEmptyGroups)
minimumTimeoutForEmptyGroups
- The minimum timeout.public void setReleasePartialSequences(boolean releasePartialSequences)
releasePartialSequences
on an underlying
SequenceSizeReleaseStrategy
.releasePartialSequences
- true to allow release.public void setExpireGroupsUponTimeout(boolean expireGroupsUponTimeout)
expireGroupsUponTimeout
- the expireGroupsUponTimeout to setpublic String getComponentType()
IntegrationObjectSupport
getComponentType
in interface NamedComponent
getComponentType
in class AbstractMessageHandler
public MessageGroupStore getMessageStore()
protected Map<UUID,ScheduledFuture<?>> getExpireGroupScheduledFutures()
protected MessageGroupProcessor getOutputProcessor()
protected CorrelationStrategy getCorrelationStrategy()
protected ReleaseStrategy getReleaseStrategy()
public MessageChannel getDiscardChannel()
DiscardingMessageHandler
getDiscardChannel
in interface DiscardingMessageHandler
protected String getDiscardChannelName()
protected boolean isSendPartialResultOnExpiry()
protected boolean isSequenceAware()
protected LockRegistry getLockRegistry()
protected boolean isLockRegistrySet()
protected long getMinimumTimeoutForEmptyGroups()
protected boolean isReleasePartialSequences()
protected Expression getGroupTimeoutExpression()
protected EvaluationContext getEvaluationContext()
protected void handleMessageInternal(Message<?> message) throws Exception
handleMessageInternal
in class AbstractMessageHandler
Exception
protected abstract void afterRelease(MessageGroup group, Collection<Message<?>> completedMessages)
group
- The group.completedMessages
- The completed messages.protected void afterRelease(MessageGroup group, Collection<Message<?>> completedMessages, boolean timeout)
afterRelease(MessageGroup, Collection)
is invoked.group
- The group.completedMessages
- The completed messages.timeout
- True if the release/discard was due to a timeout.protected void forceComplete(MessageGroup group)
protected int findLastReleasedSequenceNumber(Object groupId, Collection<Message<?>> partialSequence)
protected MessageGroup store(Object correlationKey, Message<?> message)
protected void expireGroup(Object correlationKey, MessageGroup group)
protected void completeGroup(Object correlationKey, MessageGroup group)
protected Collection<Message<?>> completeGroup(Message<?> message, Object correlationKey, MessageGroup group)
protected void verifyResultCollectionConsistsOfMessages(Collection<?> elements)
protected Long obtainGroupTimeout(MessageGroup group)
public void destroy() throws Exception
destroy
in interface DisposableBean
Exception