org.springframework.amqp.rabbit.listener.adapter

Class AbstractAdaptableMessageListener

java.lang.Object

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

All Implemented Interfaces:

MessageListener, ChannelAwareMessageListener

Direct Known Subclasses:

MessageListenerAdapter, MessagingMessageListenerAdapter

public abstract class AbstractAdaptableMessageListener
extends Object
implements ChannelAwareMessageListener

An abstract MessageListener adapter providing the necessary infrastructure to extract the payload of a Message.

Since:

1.4

Author:

Stephane Nicoll, Gary Russell, Artem Bilan, Johan Haleby

See Also:

ChannelAwareMessageListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAdaptableMessageListener.ReplyExpressionRoot Root object for reply expression evaluation.

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger Logger available to subclasses.

Constructor Summary

Constructors

Constructor and Description
AbstractAdaptableMessageListener()

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.
void	containerAckMode(AcknowledgeMode mode) Called by the container to inform the listener of its acknowledgement mode.
protected void	doHandleResult(InvocationResult resultArg, Message request, com.rabbitmq.client.Channel channel, Object source)
protected void	doPublish(com.rabbitmq.client.Channel channel, Address replyTo, Message message)
protected Object	extractMessage(Message message) Extract the message body from the given Rabbit message.
String	getEncoding() The encoding to use when inter-converting between byte arrays and Strings in message properties.
protected MessageConverter	getMessageConverter() Return the converter that will convert incoming Rabbit messages to listener method arguments, and objects returned from listener methods back to Rabbit messages.
protected String	getReceivedExchange(Message request)
protected Address	getReplyToAddress(Message request, Object source, InvocationResult result) Determine a reply-to Address for the given message.
protected void	handleListenerException(Throwable ex) Handle the given exception that arose during listener execution.
protected void	handleResult(InvocationResult resultArg, Message request, com.rabbitmq.client.Channel channel) Handle the given result object returned from the listener method, sending a response message back.
protected void	handleResult(InvocationResult resultArg, Message request, com.rabbitmq.client.Channel channel, Object source) Handle the given result object returned from the listener method, sending a response message back.
protected void	postProcessChannel(com.rabbitmq.client.Channel channel, Message response) Post-process the given message before sending the response.
protected void	postProcessResponse(Message request, Message response) Post-process the given response message before it will be sent.
protected void	sendResponse(com.rabbitmq.client.Channel channel, Address replyTo, Message messageIn) Send the given response message to the given destination.
void	setBeanResolver(BeanResolver beanResolver) Set a bean resolver for runtime SpEL expressions.
void	setBeforeSendReplyPostProcessors(MessagePostProcessor... beforeSendReplyPostProcessors) Set post processors that will be applied before sending replies.
void	setDefaultRequeueRejected(boolean defaultRequeueRejected) Set to the value of this listener's container equivalent property.
void	setEncoding(String encoding) The encoding to use when inter-converting between byte arrays and Strings in message properties.
void	setMandatoryPublish(boolean mandatoryPublish)
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.
void	setRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback) Set a RecoveryCallback to invoke when retries are exhausted.
void	setResponseAddress(String defaultReplyTo) Set the default replyTo address to use when sending response messages.
void	setResponseExchange(String responseExchange) Set the exchange to use when sending response messages.
void	setResponseRoutingKey(String responseRoutingKey) Set the routing key to use when sending response messages.
void	setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate) Set a RetryTemplate to use when sending replies.

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, onMessage, onMessageBatch

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

onMessageBatch

Field Detail

logger

protected final Log logger

Logger available to subclasses.

Constructor Detail

AbstractAdaptableMessageListener

public AbstractAdaptableMessageListener()

Method Detail

setResponseRoutingKey

public void setResponseRoutingKey(String responseRoutingKey)

Set the routing key to use when sending response messages. This will be applied in case of a request message that does not carry a "ReplyTo" property

Response destinations are only relevant for listener methods that return result objects, which will be wrapped in a response message and sent to a response destination.

Parameters:

responseRoutingKey - The routing key.

setEncoding

public void setEncoding(String encoding)

The encoding to use when inter-converting between byte arrays and Strings in message properties.

Parameters:

encoding - the encoding to set.

getEncoding

public String getEncoding()

The encoding to use when inter-converting between byte arrays and Strings in message properties.

Returns:

encoding the encoding.

setResponseExchange

public void setResponseExchange(String responseExchange)

Set the exchange to use when sending response messages. This is only used if the exchange from the received message is null.

Response destinations are only relevant for listener methods that return result objects, which will be wrapped in a response message and sent to a response destination.

Parameters:

responseExchange - The exchange.

setResponseAddress

public void setResponseAddress(String defaultReplyTo)

Set the default replyTo address to use when sending response messages. This is only used if the replyTo from the received message is null.

Response destinations are only relevant for listener methods that return result objects, which will be wrapped in a response message and sent to a response destination.

It can be a string surrounded by "!{...}" in which case the expression is evaluated at runtime; see the reference manual for more information.

Parameters:

defaultReplyTo - The exchange.

Since:

1.6

setMandatoryPublish

public void setMandatoryPublish(boolean mandatoryPublish)

setMessageConverter

public 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.

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

Parameters:

messageConverter - The message converter.

setBeforeSendReplyPostProcessors

public void setBeforeSendReplyPostProcessors(MessagePostProcessor... beforeSendReplyPostProcessors)

Set post processors that will be applied before sending replies.

Parameters:

beforeSendReplyPostProcessors - the post processors.

Since:

2.0.3

setRetryTemplate

public void setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)

Set a RetryTemplate to use when sending replies.

Parameters:

retryTemplate - the template.

Since:

2.0.6

See Also:

setRecoveryCallback(RecoveryCallback)

setRecoveryCallback

public void setRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)

Set a RecoveryCallback to invoke when retries are exhausted.

Parameters:

recoveryCallback - the recovery callback.

Since:

2.0.6

See Also:

setRetryTemplate(RetryTemplate)

setBeanResolver

public void setBeanResolver(BeanResolver beanResolver)

Set a bean resolver for runtime SpEL expressions. Also configures the evaluation context with a standard type converter and map accessor.

Parameters:

beanResolver - the resolver.

Since:

1.6

getMessageConverter

protected MessageConverter getMessageConverter()

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

Returns:

The message converter.

setDefaultRequeueRejected

public void setDefaultRequeueRejected(boolean defaultRequeueRejected)

Set to the value of this listener's container equivalent property. Used when rejecting from an async listener.

Parameters:

defaultRequeueRejected - false to not requeue.

Since:

2.1.8

containerAckMode

public void containerAckMode(AcknowledgeMode mode)

Description copied from interface: MessageListener

Called by the container to inform the listener of its acknowledgement mode.

Specified by:

containerAckMode in interface MessageListener

Parameters:

mode - the AcknowledgeMode.

handleListenerException

protected void handleListenerException(Throwable ex)

Handle the given exception that arose during listener execution. The default implementation logs the exception at error level.

Can be used by inheritors from overridden ChannelAwareMessageListener.onMessage(Message) or ChannelAwareMessageListener.onMessage(Message, com.rabbitmq.client.Channel)

Parameters:

ex - the exception to handle

extractMessage

protected Object extractMessage(Message message)

Extract the message body from the given Rabbit message.

Parameters:

message - the Rabbit Message

Returns:

the content of the message, to be passed into the listener method as argument

handleResult

protected void handleResult(InvocationResult resultArg,
                            Message request,
                            com.rabbitmq.client.Channel channel)

Handle the given result object returned from the listener method, sending a response message back.

Parameters:

resultArg - the result object to handle (never null)

request - the original request message

channel - the Rabbit channel to operate on (may be null)

See Also:

buildMessage(com.rabbitmq.client.Channel, java.lang.Object, java.lang.reflect.Type), postProcessResponse(org.springframework.amqp.core.Message, org.springframework.amqp.core.Message), getReplyToAddress(Message, Object, InvocationResult), sendResponse(com.rabbitmq.client.Channel, org.springframework.amqp.core.Address, org.springframework.amqp.core.Message)

handleResult

protected void handleResult(InvocationResult resultArg,
                            Message request,
                            com.rabbitmq.client.Channel channel,
                            Object source)

Handle the given result object returned from the listener method, sending a response message back.

Parameters:

resultArg - the result object to handle (never null)

request - the original request message

channel - the Rabbit channel to operate on (may be null)

source - the source data for the method invocation - e.g. o.s.messaging.Message<?>; may be null

See Also:

buildMessage(com.rabbitmq.client.Channel, java.lang.Object, java.lang.reflect.Type), postProcessResponse(org.springframework.amqp.core.Message, org.springframework.amqp.core.Message), getReplyToAddress(Message, Object, InvocationResult), sendResponse(com.rabbitmq.client.Channel, org.springframework.amqp.core.Address, org.springframework.amqp.core.Message)

doHandleResult

protected void doHandleResult(InvocationResult resultArg,
                              Message request,
                              com.rabbitmq.client.Channel channel,
                              Object source)

getReceivedExchange

protected String getReceivedExchange(Message request)

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.

Parameters:

channel - the Rabbit Channel to operate on.

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

genericType - the generic type to populate type headers.

Returns:

the Rabbit Message (never null).

See Also:

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

postProcessResponse

protected void postProcessResponse(Message request,
                                   Message response)

Post-process the given response message before it will be sent.

The default implementation sets the response's correlation id to the request message's correlation id, if any; otherwise to the request message id.

Parameters:

request - the original incoming Rabbit message

response - the outgoing Rabbit message about to be sent

getReplyToAddress

protected Address getReplyToAddress(Message request,
                                    Object source,
                                    InvocationResult result)

Determine a reply-to Address for the given message.

The default implementation first checks the Rabbit Reply-To Address of the supplied request; if that is not null it is returned; if it is null, then the configured default response Exchange and routing key are used to construct a reply-to Address. If the responseExchange property is also null, then an AmqpException is thrown.

Parameters:

request - the original incoming Rabbit message.

source - the source data (e.g. o.s.messaging.Message<?>).

result - the result.

Returns:

the reply-to Address (never null)

Throws:

AmqpException - if no Address can be determined

See Also:

setResponseAddress(String), setResponseRoutingKey(String), Message.getMessageProperties(), MessageProperties.getReplyTo()

sendResponse

protected void sendResponse(com.rabbitmq.client.Channel channel,
                            Address replyTo,
                            Message messageIn)

Send the given response message to the given destination.

Parameters:

channel - the Rabbit channel to operate on

replyTo - the Rabbit ReplyTo string to use when sending. Currently interpreted to be the routing key.

messageIn - the Rabbit message to send

See Also:

postProcessResponse(Message, Message)

doPublish

protected void doPublish(com.rabbitmq.client.Channel channel,
                         Address replyTo,
                         Message message)
                  throws IOException

Throws:

IOException

postProcessChannel

protected void postProcessChannel(com.rabbitmq.client.Channel channel,
                                  Message response)

Post-process the given message before sending the response.

The default implementation is empty.

Parameters:

channel - The channel.

response - the outgoing Rabbit message about to be sent