public abstract class AbstractCorrelatingMessageHandler extends AbstractMessageHandler implements MessageProducer, DisposableBean, IntegrationEvaluationContextAware
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 |
| Modifier and Type | Field and Description |
|---|---|
static long |
DEFAULT_SEND_TIMEOUT |
protected MessageGroupStore |
messageStore |
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 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) |
String |
getComponentType()
Subclasses may implement this method to provide component type information.
|
protected CorrelationStrategy |
getCorrelationStrategy() |
protected MessageChannel |
getDiscardChannel() |
protected String |
getDiscardChannelName() |
protected EvaluationContext |
getEvaluationContext() |
protected Map<UUID,ScheduledFuture<?>> |
getExpireGroupScheduledFutures() |
protected Expression |
getGroupTimeoutExpression() |
protected LockRegistry |
getLockRegistry() |
protected MessageGroupStore |
getMessageStore() |
protected MessagingTemplate |
getMessagingTemplate() |
protected long |
getMinimumTimeoutForEmptyGroups() |
protected MessageChannel |
getOutputChannel() |
protected String |
getOutputChannelName() |
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.
|
protected void |
sendReplies(Object processorResult,
Message message) |
protected void |
sendReplyMessage(Object reply,
Object replyChannel) |
void |
setCorrelationStrategy(CorrelationStrategy correlationStrategy) |
void |
setDiscardChannel(MessageChannel discardChannel) |
void |
setDiscardChannelName(String discardChannelName) |
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 |
setOutputChannel(MessageChannel outputChannel)
Specify the MessageChannel to which produced Messages should be sent.
|
void |
setOutputChannelName(String outputChannelName) |
void |
setReleasePartialSequences(boolean releasePartialSequences) |
void |
setReleaseStrategy(ReleaseStrategy releaseStrategy) |
void |
setSendPartialResultOnExpiry(boolean sendPartialResultOnExpiry) |
void |
setSendTimeout(long sendTimeout) |
void |
setTaskScheduler(TaskScheduler taskScheduler) |
protected boolean |
shouldSendMultipleReplies(Iterable<?> iter) |
protected MessageGroup |
store(Object correlationKey,
Message<?> message) |
protected void |
verifyResultCollectionConsistsOfMessages(Collection<?> elements) |
getOrder, handleMessage, setOrder, setShouldTrackafterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetComponentNamepublic static final long DEFAULT_SEND_TIMEOUT
protected volatile MessageGroupStore messageStore
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 void setMessageStore(MessageGroupStore store)
public void setCorrelationStrategy(CorrelationStrategy correlationStrategy)
public void setReleaseStrategy(ReleaseStrategy releaseStrategy)
public void setOutputChannel(MessageChannel outputChannel)
MessageProducersetOutputChannel in interface MessageProduceroutputChannel - The output channel.public void setOutputChannelName(String outputChannelName)
public void setGroupTimeoutExpression(Expression groupTimeoutExpression)
public void setIntegrationEvaluationContext(EvaluationContext evaluationContext)
setIntegrationEvaluationContext in interface IntegrationEvaluationContextAwarepublic void setTaskScheduler(TaskScheduler taskScheduler)
setTaskScheduler in class IntegrationObjectSupportprotected void onInit()
throws Exception
IntegrationObjectSupportonInit in class IntegrationObjectSupportException - Any exception.public void setDiscardChannel(MessageChannel discardChannel)
public void setDiscardChannelName(String discardChannelName)
public void setSendTimeout(long sendTimeout)
public void setSendPartialResultOnExpiry(boolean sendPartialResultOnExpiry)
public void setMinimumTimeoutForEmptyGroups(long minimumTimeoutForEmptyGroups)
minimumTimeoutForEmptyGroups - The minimum timeout.public void setReleasePartialSequences(boolean releasePartialSequences)
public String getComponentType()
IntegrationObjectSupportgetComponentType in interface NamedComponentgetComponentType in class AbstractMessageHandlerprotected MessageGroupStore getMessageStore()
protected Map<UUID,ScheduledFuture<?>> getExpireGroupScheduledFutures()
protected MessageGroupProcessor getOutputProcessor()
protected CorrelationStrategy getCorrelationStrategy()
protected ReleaseStrategy getReleaseStrategy()
protected MessageChannel getOutputChannel()
protected String getOutputChannelName()
protected MessagingTemplate getMessagingTemplate()
protected MessageChannel getDiscardChannel()
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 AbstractMessageHandlerExceptionprotected abstract void afterRelease(MessageGroup group, Collection<Message<?>> completedMessages)
group - The group.completedMessages - The completed messages.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 boolean shouldSendMultipleReplies(Iterable<?> iter)
protected Long obtainGroupTimeout(MessageGroup group)
public void destroy()
throws Exception
destroy in interface DisposableBeanException