org.springframework.amqp.rabbit.listener.adapter

Class MessagingMessageListenerAdapter

java.lang.Object

org.springframework.amqp.rabbit.listener.adapter.AbstractAdaptableMessageListener

org.springframework.amqp.rabbit.listener.adapter.MessagingMessageListenerAdapter

All Implemented Interfaces:

MessageListener, ChannelAwareMessageListener

Direct Known Subclasses:

BatchMessagingMessageListenerAdapter

public class MessagingMessageListenerAdapter
extends AbstractAdaptableMessageListener

A MessageListener adapter that invokes a configurable HandlerAdapter.

Wraps the incoming AMQP Message to Spring's Message abstraction, copying the standard headers using a configurable AmqpHeaderMapper.

The original Message and the Channel are provided as additional arguments so that these can be injected as method arguments if necessary.

Since:

1.4

Author:

Stephane Nicoll, Gary Russell, Artem Bilan, Kai Stapel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MessagingMessageListenerAdapter.MessagingMessageConverterAdapter Delegates payload extraction to AbstractAdaptableMessageListener.extractMessage(org.springframework.amqp.core.Message message) to enforce backward compatibility.

Nested classes/interfaces inherited from class org.springframework.amqp.rabbit.listener.adapter.AbstractAdaptableMessageListener

AbstractAdaptableMessageListener.ReplyExpressionRoot

Field Summary

Fields inherited from class org.springframework.amqp.rabbit.listener.adapter.AbstractAdaptableMessageListener

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
	MessagingMessageListenerAdapter()
	MessagingMessageListenerAdapter(Object bean, Method method)
	MessagingMessageListenerAdapter(Object bean, Method method, boolean returnExceptions, RabbitListenerErrorHandler errorHandler)
protected	MessagingMessageListenerAdapter(Object bean, Method method, boolean returnExceptions, RabbitListenerErrorHandler errorHandler, boolean batch)

Method Summary

Modifier and Type	Method and Description
protected Message	buildMessage(com.rabbitmq.client.Channel channel, Object result, Type genericType) Build a Rabbit message to be sent as response based on the given result object.
protected MessagingMessageConverter	getMessagingMessageConverter()
protected void	invokeHandlerAndProcessResult(Message amqpMessage, com.rabbitmq.client.Channel channel, Message<?> message)
void	onMessage(Message amqpMessage, com.rabbitmq.client.Channel channel) Callback for processing a received Rabbit message.
void	setHandlerAdapter(HandlerAdapter handlerAdapter) Set the HandlerAdapter to use to invoke the method processing an incoming Message.
void	setHeaderMapper(AmqpHeaderMapper headerMapper) Set the AmqpHeaderMapper implementation to use to map the standard AMQP headers.
void	setMessageConverter(MessageConverter messageConverter) Set the converter that will convert incoming Rabbit messages to listener method arguments, and objects returned from listener methods back to Rabbit messages.
protected Message<?>	toMessagingMessage(Message amqpMessage)

Methods inherited from class org.springframework.amqp.rabbit.listener.adapter.AbstractAdaptableMessageListener

containerAckMode, convert, doHandleResult, doPublish, extractMessage, getEncoding, getMessageConverter, getReceivedExchange, getReplyContentType, getReplyToAddress, handleListenerException, handleResult, handleResult, isConverterWinsContentType, postProcessChannel, postProcessResponse, sendResponse, setBeanResolver, setBeforeSendReplyPostProcessors, setConverterWinsContentType, setDefaultRequeueRejected, setEncoding, setMandatoryPublish, setRecoveryCallback, setReplyContentType, setReplyPostProcessor, setResponseAddress, setResponseExchange, setResponseRoutingKey, setRetryTemplate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.amqp.rabbit.listener.api.ChannelAwareMessageListener

onMessage, onMessageBatch

Methods inherited from interface org.springframework.amqp.core.MessageListener

onMessageBatch

Constructor Detail

MessagingMessageListenerAdapter

public MessagingMessageListenerAdapter()

MessagingMessageListenerAdapter

public MessagingMessageListenerAdapter(Object bean,
                                       Method method)

MessagingMessageListenerAdapter

public MessagingMessageListenerAdapter(Object bean,
                                       Method method,
                                       boolean returnExceptions,
                                       RabbitListenerErrorHandler errorHandler)

MessagingMessageListenerAdapter

protected MessagingMessageListenerAdapter(Object bean,
                                          Method method,
                                          boolean returnExceptions,
                                          RabbitListenerErrorHandler errorHandler,
                                          boolean batch)

Method Detail

setHandlerAdapter

public void setHandlerAdapter(HandlerAdapter handlerAdapter)

Set the HandlerAdapter to use to invoke the method processing an incoming Message.

Parameters:

handlerAdapter - HandlerAdapter instance.

setHeaderMapper

public void setHeaderMapper(AmqpHeaderMapper headerMapper)

Set the AmqpHeaderMapper implementation to use to map the standard AMQP headers. By default, a SimpleAmqpHeaderMapper is used.

Parameters:

headerMapper - the AmqpHeaderMapper instance.

See Also:

SimpleAmqpHeaderMapper

getMessagingMessageConverter

protected final MessagingMessageConverter getMessagingMessageConverter()

Returns:

the MessagingMessageConverter for this listener, being able to convert Message.

setMessageConverter

public void setMessageConverter(MessageConverter messageConverter)

Description copied from class: AbstractAdaptableMessageListener

Set the converter that will convert incoming Rabbit messages to listener method arguments, and objects returned from listener methods back to Rabbit messages.

The default converter is a SimpleMessageConverter, which is able to handle "text" content-types.

Overrides:

setMessageConverter in class AbstractAdaptableMessageListener

Parameters:

messageConverter - The message converter.

onMessage

public void onMessage(Message amqpMessage,
                      com.rabbitmq.client.Channel channel)
               throws Exception

Description copied from interface: ChannelAwareMessageListener

Callback for processing a received Rabbit message.

Implementors are supposed to process the given Message, typically sending reply messages through the given Session.

Parameters:

amqpMessage - the received AMQP message (never null)

channel - the underlying Rabbit Channel (never null)

Throws:

Exception - Any.

invokeHandlerAndProcessResult

protected void invokeHandlerAndProcessResult(@Nullable
                                             Message amqpMessage,
                                             com.rabbitmq.client.Channel channel,
                                             Message<?> message)
                                      throws Exception

Throws:

Exception

toMessagingMessage

protected Message<?> toMessagingMessage(Message amqpMessage)

buildMessage

protected Message buildMessage(com.rabbitmq.client.Channel channel,
                               Object result,
                               Type genericType)

Build a Rabbit message to be sent as response based on the given result object.

Overrides:

buildMessage in class AbstractAdaptableMessageListener

Parameters:

channel - the Rabbit Channel to operate on

result - the content of the message, as returned from the listener method

genericType - the generic type of the result.

Returns:

the Rabbit Message (never null)

See Also:

setMessageConverter(org.springframework.amqp.support.converter.MessageConverter)