org.springframework.integration.handler

Class AbstractReplyProducingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractMessageSplitter, AbstractRemoteFileOutboundGateway, AbstractReplyProducingPostProcessingMessageHandler, AbstractWebServiceOutboundGateway, AmqpOutboundEndpoint, BridgeHandler, ContentEnricher, DelayHandler, FileWritingMessageHandler, HttpRequestExecutingMessageHandler, JdbcOutboundGateway, JmsOutboundGateway, JpaOutboundGateway, MessageTransformingHandler, OperationInvokingMessageHandler, RedisOutboundGateway, RmiOutboundGateway, ServiceActivatingHandler, StoredProcOutboundGateway, TcpOutboundGateway, TwitterSearchOutboundGateway

public abstract class AbstractReplyProducingMessageHandler
extends AbstractMessageHandler
implements MessageProducer, BeanClassLoaderAware

Base class for MessageHandlers that are capable of producing replies.

Author:

Mark Fisher, Iwein Fuld, Oleg Zhurakousky, Gary Russell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

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
AbstractReplyProducingMessageHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInit()
protected Object	doInvokeAdvisedRequestHandler(Message<?> message)
protected MessagingTemplate	getMessagingTemplate() Provides access to the MessagingTemplate for subclasses.
protected void	handleMessageInternal(Message<?> message)
protected abstract Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
protected boolean	hasAdviceChain()
protected void	onInit() Subclasses may implement this for initialization logic.
void	setAdviceChain(List<org.aopalliance.aop.Advice> adviceChain)
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setChannelResolver(DestinationResolver<MessageChannel> channelResolver) Set the DestinationResolver<MessageChannel> to be used when there is no default output channel.
void	setOutputChannel(MessageChannel outputChannel) Specify the MessageChannel to which produced Messages should be sent.
void	setOutputChannelName(String outputChannelName)
void	setRequiresReply(boolean requiresReply) Flag whether a reply is required.
void	setSendTimeout(long sendTimeout) Set the timeout for sending reply Messages.
protected boolean	shouldCopyRequestHeaders() Subclasses may override this.

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

getComponentType, getOrder, handleMessage, setOrder, setShouldTrack

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

afterPropertiesSet, 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

AbstractReplyProducingMessageHandler

public AbstractReplyProducingMessageHandler()

Method Detail

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)

setSendTimeout

public void setSendTimeout(long sendTimeout)

Set the timeout for sending reply Messages.

Parameters:

sendTimeout - The send timeout.

setChannelResolver

public void setChannelResolver(DestinationResolver<MessageChannel> channelResolver)

Set the DestinationResolver<MessageChannel> to be used when there is no default output channel.

Parameters:

channelResolver - The channel resolver.

setRequiresReply

public void setRequiresReply(boolean requiresReply)

Flag whether a reply is required. If true an incoming message MUST result in a reply message being sent. If false an incoming message MAY result in a reply message being sent. Default is false.

Parameters:

requiresReply - true if a reply is required.

getMessagingTemplate

protected MessagingTemplate getMessagingTemplate()

Provides access to the MessagingTemplate for subclasses.

Returns:

The messaging template.

setAdviceChain

public void setAdviceChain(List<org.aopalliance.aop.Advice> adviceChain)

hasAdviceChain

protected boolean hasAdviceChain()

setBeanClassLoader

public void setBeanClassLoader(ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

onInit

protected final void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

doInit

protected void doInit()

handleMessageInternal

protected final void handleMessageInternal(Message<?> message)

Specified by:

handleMessageInternal in class AbstractMessageHandler

doInvokeAdvisedRequestHandler

protected Object doInvokeAdvisedRequestHandler(Message<?> message)

shouldCopyRequestHeaders

protected boolean shouldCopyRequestHeaders()

Subclasses may override this. True by default.

Returns:

true if the request headers should be copied.

handleRequestMessage

protected abstract Object handleRequestMessage(Message<?> requestMessage)

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.

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.