Class MessagingTemplate

java.lang.Object

org.springframework.messaging.core.AbstractMessageSendingTemplate<MessageChannel>

org.springframework.messaging.core.AbstractMessageReceivingTemplate<MessageChannel>

org.springframework.messaging.core.AbstractMessagingTemplate<MessageChannel>

org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate<MessageChannel>

org.springframework.messaging.core.GenericMessagingTemplate

org.springframework.integration.core.MessagingTemplate

All Implemented Interfaces:

Aware, BeanFactoryAware, DestinationResolvingMessageReceivingOperations<MessageChannel>, DestinationResolvingMessageRequestReplyOperations<MessageChannel>, DestinationResolvingMessageSendingOperations<MessageChannel>, MessageReceivingOperations<MessageChannel>, MessageRequestReplyOperations<MessageChannel>, MessageSendingOperations<MessageChannel>

Direct Known Subclasses:

AsyncMessagingTemplate, MessagingGatewaySupport.ConvertingMessagingTemplate

public class MessagingTemplate
extends GenericMessagingTemplate

Since:

1.0

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan, Christian Tzolov

Field Summary

Fields inherited from class org.springframework.messaging.core.GenericMessagingTemplate

DEFAULT_RECEIVE_TIMEOUT_HEADER, DEFAULT_SEND_TIMEOUT_HEADER

Fields inherited from class org.springframework.messaging.core.AbstractMessageSendingTemplate

CONVERSION_HINT_HEADER, logger

Constructor Summary

Constructors

Constructor	Description
MessagingTemplate()	Create a MessagingTemplate with no default channel.
MessagingTemplate(MessageChannel defaultChannel)	Create a MessagingTemplate with the given default channel.

Method Summary

Modifier and Type	Method	Description
@Nullable Message<?>	receive(MessageChannel destination, long timeout)
@Nullable Object	receiveAndConvert(MessageChannel destination, long timeout)
@Nullable Message<?>	sendAndReceive(MessageChannel destination, Message<?> requestMessage)
void	setBeanFactory(BeanFactory beanFactory)	Overridden to set the destination resolver to a integrationChannelResolver bean.
void	setDefaultChannel(@Nullable MessageChannel channel)	Invokes setDefaultDestination(MessageChannel) - provided for backward compatibility.
void	setThrowExceptionOnLateReply(boolean throwExceptionOnLateReply)

Methods inherited from class org.springframework.messaging.core.GenericMessagingTemplate

doReceive, doReceive, doSend, doSend, doSendAndReceive, getReceiveTimeout, getReceiveTimeoutHeader, getSendTimeout, getSendTimeoutHeader, setReceiveTimeout, setReceiveTimeoutHeader, setSendTimeout, setSendTimeoutHeader

Methods inherited from class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, getDestinationResolver, receive, receiveAndConvert, resolveDestination, send, sendAndReceive, setDestinationResolver

Methods inherited from class org.springframework.messaging.core.AbstractMessagingTemplate

convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, sendAndReceive

Methods inherited from class org.springframework.messaging.core.AbstractMessageReceivingTemplate

doConvert, receive, receive, receiveAndConvert, receiveAndConvert

Methods inherited from class org.springframework.messaging.core.AbstractMessageSendingTemplate

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, doConvert, getDefaultDestination, getMessageConverter, getRequiredDefaultDestination, processHeadersToSend, send, send, setDefaultDestination, setMessageConverter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.messaging.core.MessageReceivingOperations

receive, receive, receiveAndConvert, receiveAndConvert

Methods inherited from interface org.springframework.messaging.core.MessageRequestReplyOperations

convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, sendAndReceive

Methods inherited from interface org.springframework.messaging.core.MessageSendingOperations

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, send, send

Constructor Details

MessagingTemplate

public MessagingTemplate()

Create a MessagingTemplate with no default channel. Note, that one may be provided by invoking setDefaultChannel(MessageChannel).

MessagingTemplate

public MessagingTemplate(MessageChannel defaultChannel)

Create a MessagingTemplate with the given default channel.

Parameters:

defaultChannel - the default MessageChannel for send operations

Method Details

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Overridden to set the destination resolver to a integrationChannelResolver bean.

Specified by:

setBeanFactory in interface BeanFactoryAware

Overrides:

setBeanFactory in class GenericMessagingTemplate

Throws:

BeansException

setThrowExceptionOnLateReply

public void setThrowExceptionOnLateReply(boolean throwExceptionOnLateReply)

Overrides:

setThrowExceptionOnLateReply in class GenericMessagingTemplate

setDefaultChannel

public void setDefaultChannel(@Nullable MessageChannel channel)

Invokes setDefaultDestination(MessageChannel) - provided for backward compatibility.

Parameters:

channel - the channel to set.

sendAndReceive

public @Nullable Message<?> sendAndReceive(MessageChannel destination,
 Message<?> requestMessage)

Specified by:

sendAndReceive in interface MessageRequestReplyOperations<MessageChannel>

Overrides:

sendAndReceive in class AbstractMessagingTemplate<MessageChannel>

receiveAndConvert

public @Nullable Object receiveAndConvert(MessageChannel destination,
 long timeout)

receive

public @Nullable Message<?> receive(MessageChannel destination,
 long timeout)