org.springframework.amqp.rabbit.retry

Class RepublishMessageRecoverer

java.lang.Object

org.springframework.amqp.rabbit.retry.RepublishMessageRecoverer

All Implemented Interfaces:

MessageRecoverer

public class RepublishMessageRecoverer
extends Object
implements MessageRecoverer

MessageRecoverer implementation that republishes recovered messages to a specified exchange with the exception stack trace stored in the message header x-exception.

If no routing key is provided, the original routing key for the message, prefixed with setErrorRoutingKeyPrefix(String) (default "error.") will be used to publish the message to the exchange provided in name, or the template's default exchange if none is set.

Since:

1.3

Author:

James Carr, Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FRAME_MAX_HEADROOM
protected String	errorExchangeName
protected String	errorRoutingKey
protected AmqpTemplate	errorTemplate
protected Log	logger
static String	X_EXCEPTION_MESSAGE
static String	X_EXCEPTION_STACKTRACE
static String	X_ORIGINAL_EXCHANGE
static String	X_ORIGINAL_ROUTING_KEY

Constructor Summary

Constructors

Constructor and Description
RepublishMessageRecoverer(AmqpTemplate errorTemplate)
RepublishMessageRecoverer(AmqpTemplate errorTemplate, String errorExchange)
RepublishMessageRecoverer(AmqpTemplate errorTemplate, String errorExchange, String errorRoutingKey)

Method Summary

Modifier and Type	Method and Description
protected Map<? extends String,?>	additionalHeaders(Message message, Throwable cause) Subclasses can override this method to add more headers to the republished message.
RepublishMessageRecoverer	errorRoutingKeyPrefix(String errorRoutingKeyPrefix) Apply a prefix to the outbound routing key, which will be prefixed to the original message routing key (if no explicit routing key was provided in the constructor; ignored otherwise.
RepublishMessageRecoverer	frameMaxHeadroom(int headroom) Set the amount by which the negotiated frame_max is to be reduced when considering truncating the stack trace header.
protected MessageDeliveryMode	getDeliveryMode()
protected String	getErrorRoutingKeyPrefix()
void	recover(Message message, Throwable cause) Callback for message that was consumed but failed all retry attempts.
void	setDeliveryMode(MessageDeliveryMode deliveryMode) Specify a MessageDeliveryMode to set into the message to republish if the message doesn't have it already.
void	setErrorRoutingKeyPrefix(String errorRoutingKeyPrefix)

Methods inherited from class java.lang.Object

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

Field Detail

X_EXCEPTION_STACKTRACE

public static final String X_EXCEPTION_STACKTRACE

See Also:

Constant Field Values

X_EXCEPTION_MESSAGE

public static final String X_EXCEPTION_MESSAGE

See Also:

Constant Field Values

X_ORIGINAL_EXCHANGE

public static final String X_ORIGINAL_EXCHANGE

See Also:

Constant Field Values

X_ORIGINAL_ROUTING_KEY

public static final String X_ORIGINAL_ROUTING_KEY

See Also:

Constant Field Values

DEFAULT_FRAME_MAX_HEADROOM

public static final int DEFAULT_FRAME_MAX_HEADROOM

See Also:

Constant Field Values

logger

protected final Log logger

errorTemplate

protected final AmqpTemplate errorTemplate

errorRoutingKey

protected final String errorRoutingKey

errorExchangeName

protected final String errorExchangeName

Constructor Detail

RepublishMessageRecoverer

public RepublishMessageRecoverer(AmqpTemplate errorTemplate)

RepublishMessageRecoverer

public RepublishMessageRecoverer(AmqpTemplate errorTemplate,
                                 String errorExchange)

RepublishMessageRecoverer

public RepublishMessageRecoverer(AmqpTemplate errorTemplate,
                                 String errorExchange,
                                 String errorRoutingKey)

Method Detail

errorRoutingKeyPrefix

public RepublishMessageRecoverer errorRoutingKeyPrefix(String errorRoutingKeyPrefix)

Apply a prefix to the outbound routing key, which will be prefixed to the original message routing key (if no explicit routing key was provided in the constructor; ignored otherwise. Use an empty string ("") for no prefixing.

Parameters:

errorRoutingKeyPrefix - The prefix (default "error.").

Returns:

this.

frameMaxHeadroom

public RepublishMessageRecoverer frameMaxHeadroom(int headroom)

Set the amount by which the negotiated frame_max is to be reduced when considering truncating the stack trace header. Defaults to 20000.

Parameters:

headroom - the headroom

Returns:

this.

Since:

2.0.5

setErrorRoutingKeyPrefix

public void setErrorRoutingKeyPrefix(String errorRoutingKeyPrefix)

Parameters:

errorRoutingKeyPrefix - The prefix (default "error.").

See Also:

errorRoutingKeyPrefix(String)

getErrorRoutingKeyPrefix

protected String getErrorRoutingKeyPrefix()

setDeliveryMode

public void setDeliveryMode(MessageDeliveryMode deliveryMode)

Specify a MessageDeliveryMode to set into the message to republish if the message doesn't have it already.

Parameters:

deliveryMode - the delivery mode to set to message.

Since:

2.0

getDeliveryMode

protected MessageDeliveryMode getDeliveryMode()

recover

public void recover(Message message,
                    Throwable cause)

Description copied from interface: MessageRecoverer

Callback for message that was consumed but failed all retry attempts.

Specified by:

recover in interface MessageRecoverer

Parameters:

message - the message to recover

cause - the cause of the error

additionalHeaders

protected Map<? extends String,?> additionalHeaders(Message message,
                                                    Throwable cause)

Subclasses can override this method to add more headers to the republished message.

Parameters:

message - The failed message.

cause - The cause.

Returns:

A Map of additional headers to add.