org.springframework.integration.handler

Class ScatterGatherHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.handler.ScatterGatherHandler

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Lifecycle, Ordered, Orderable, MessageProducer, TrackableComponent, NamedComponent, MessageHandler

public class ScatterGatherHandler
extends AbstractReplyProducingMessageHandler
implements Lifecycle

The MessageHandler implementation for the Scatter-Gather EIP pattern.

Since:

4.1

Author:

Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

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

messagingTemplate

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

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ScatterGatherHandler(MessageChannel scatterChannel, MessageHandler gatherer)
ScatterGatherHandler(MessageHandler scatterer, MessageHandler gatherer)

Method Summary

Modifier and Type	Method and Description
protected void	doInit()
protected Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
boolean	isRunning()
void	setGatherChannel(MessageChannel gatherChannel)
void	setGatherTimeout(long gatherTimeout)
void	start()
void	stop()

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

doInvokeAdvisedRequestHandler, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

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

getOutputChannel, produceOutput, sendOutputs, setChannelResolver, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput

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

getComponentType, getOrder, handleMessage, setOrder, setShouldTrack

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

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

getComponentName

Constructor Detail

ScatterGatherHandler

public ScatterGatherHandler(MessageChannel scatterChannel,
                            MessageHandler gatherer)

ScatterGatherHandler

public ScatterGatherHandler(MessageHandler scatterer,
                            MessageHandler gatherer)

Method Detail

setGatherChannel

public void setGatherChannel(MessageChannel gatherChannel)

setGatherTimeout

public void setGatherTimeout(long gatherTimeout)

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

handleRequestMessage

protected Object handleRequestMessage(Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle