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, RabbitAmqpMessageListenerAdapter, StreamMessageListenerAdapter

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	Description
protected final 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

Modifier and Type	Field	Description
protected final @Nullable RabbitListenerErrorHandler	errorHandler
protected final MessagingMessageListenerAdapter.MessagingMessageConverterAdapter	messagingMessageConverter
protected final boolean	returnExceptions

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

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	asyncFailure(Message request, @Nullable com.rabbitmq.client.Channel channel, Throwable t, @Nullable Object source)
protected Message	buildMessage(@Nullable com.rabbitmq.client.Channel channel, @Nullable Object result, @Nullable Type genericType)	Build a Rabbit message to be sent as response based on the given result object.
protected HandlerAdapter	getHandlerAdapter()
protected final MessagingMessageConverter	getMessagingMessageConverter()
protected void	handleException(Message amqpMessage, @Nullable com.rabbitmq.client.Channel channel, @Nullable Message<?> message, ListenerExecutionFailedException e)
protected InvocationResult	invokeHandler(@Nullable com.rabbitmq.client.Channel channel, Message<?> message, boolean batch, Message... amqpMessages)	Invoke the handler, wrapping any exception to a ListenerExecutionFailedException with a dedicated error message.
protected void	invokeHandlerAndProcessResult(Message amqpMessage, @Nullable com.rabbitmq.client.Channel channel, Message<?> message)
boolean	isAsyncReplies()	Return true if this listener is request/reply and the replies are async.
void	onMessage(Message amqpMessage, @Nullable 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(@Nullable 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

basicAck, containerAckMode, convert, doHandleResult, doPublish, extractMessage, getBeforeSendReplyPostProcessors, getEncoding, getMessageConverter, getReceivedExchange, getReplyContentType, getReplyToAddress, handleListenerException, handleResult, handleResult, isConverterWinsContentType, isDefaultRequeueRejected, isManualAck, 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

Field Details

messagingMessageConverter

protected final MessagingMessageListenerAdapter.MessagingMessageConverterAdapter messagingMessageConverter

returnExceptions

protected final boolean returnExceptions

errorHandler

protected final @Nullable RabbitListenerErrorHandler errorHandler

Constructor Details

MessagingMessageListenerAdapter

public MessagingMessageListenerAdapter()

MessagingMessageListenerAdapter

public MessagingMessageListenerAdapter(@Nullable Object bean,
 @Nullable Method method)

MessagingMessageListenerAdapter

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

MessagingMessageListenerAdapter

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

Method Details

setHandlerAdapter

public void setHandlerAdapter(HandlerAdapter handlerAdapter)

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

Parameters:

handlerAdapter - HandlerAdapter instance.

getHandlerAdapter

protected HandlerAdapter getHandlerAdapter()

isAsyncReplies

public boolean isAsyncReplies()

Description copied from interface: MessageListener

Return true if this listener is request/reply and the replies are async.

Returns:

true for async replies.

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(@Nullable 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,
 @Nullable 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 unless called by the stream listener container).

Throws:

Exception - Any.

asyncFailure

protected void asyncFailure(Message request,
 @Nullable com.rabbitmq.client.Channel channel,
 Throwable t,
 @Nullable Object source)

Overrides:

asyncFailure in class AbstractAdaptableMessageListener

handleException

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

Throws:

Exception

invokeHandlerAndProcessResult

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

toMessagingMessage

protected Message<?> toMessagingMessage(Message amqpMessage)

invokeHandler

protected InvocationResult invokeHandler(@Nullable com.rabbitmq.client.Channel channel,
 Message<?> message,
 boolean batch,
 Message... amqpMessages)

Invoke the handler, wrapping any exception to a ListenerExecutionFailedException with a dedicated error message.

Parameters:

channel - the channel.

message - the messaging message.

amqpMessages - the raw AMQP messages.

Returns:

the result of invoking the handler.

buildMessage

protected Message buildMessage(@Nullable com.rabbitmq.client.Channel channel,
 @Nullable Object result,
 @Nullable 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)