org.springframework.integration.handler

Class AbstractMessageProducingHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, MessageProducer, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, MessageHandler

Direct Known Subclasses:

AbstractCorrelatingMessageHandler, AbstractReplyProducingMessageHandler, MessageHandlerChain

public abstract class AbstractMessageProducingHandler
extends AbstractMessageHandler
implements MessageProducer

The base AbstractMessageHandler implementation for the MessageProducer.

Author:

David Liu, Artem Bilan, Gary Russell since 4.1

Field Summary

Fields

Modifier and Type	Field and Description
protected MessagingTemplate	messagingTemplate

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractMessageProducingHandler()

Method Summary

Modifier and Type	Method and Description
MessageChannel	getOutputChannel()
protected void	onInit() Subclasses may implement this for initialization logic.
protected void	produceOutput(Object reply, Message<?> requestMessage)
protected void	sendOutputs(Object result, Message<?> requestMessage)
protected void	setAsyncReplySupported(boolean asyncReplySupported) Allow async replies.
void	setOutputChannel(MessageChannel outputChannel) Specify the MessageChannel to which produced Messages should be sent.
void	setOutputChannelName(String outputChannelName)
void	setSendTimeout(long sendTimeout) Set the timeout for sending reply Messages.
protected boolean	shouldCopyRequestHeaders() Subclasses may override this.
protected boolean	shouldSplitOutput(Iterable<?> reply)

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

configureMetrics, getActiveCount, getActiveCountLong, getComponentType, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getStandardDeviationDuration, handleMessage, handleMessageInternal, 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, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, 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

Field Detail

messagingTemplate

protected final MessagingTemplate messagingTemplate

Constructor Detail

AbstractMessageProducingHandler

public AbstractMessageProducingHandler()

Method Detail

setSendTimeout

public void setSendTimeout(long sendTimeout)

Set the timeout for sending reply Messages.

Parameters:

sendTimeout - The send timeout.

setOutputChannel

public void setOutputChannel(MessageChannel outputChannel)

Description copied from interface: MessageProducer

Specify the MessageChannel to which produced Messages should be sent.

Specified by:

setOutputChannel in interface MessageProducer

Parameters:

outputChannel - The output channel.

setOutputChannelName

public void setOutputChannelName(String outputChannelName)

setAsyncReplySupported

protected void setAsyncReplySupported(boolean asyncReplySupported)

Allow async replies. If the handler reply is a ListenableFuture send the output when it is satisfied rather than sending the future as the result. Only subclasses that support this feature should set it.

Parameters:

asyncReplySupported - true to allow.

Since:

4.3

onInit

protected void onInit()
               throws Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageHandler

Throws:

Exception - Any exception.

getOutputChannel

public MessageChannel getOutputChannel()

sendOutputs

protected void sendOutputs(Object result,
                           Message<?> requestMessage)

shouldSplitOutput

protected boolean shouldSplitOutput(Iterable<?> reply)

produceOutput

protected void produceOutput(Object reply,
                             Message<?> requestMessage)

shouldCopyRequestHeaders

protected boolean shouldCopyRequestHeaders()

Subclasses may override this. True by default.

Returns:

true if the request headers should be copied.