Spring Framework 6.1.4 · org.springframework.messaging.support.ErrorMessage

A GenericMessage with a Throwable payload.

The payload is typically a org.springframework.messaging.MessagingException with the message at the point of failure in its failedMessage property. An optional originalMessage may be provided, which represents the message that existed at the point in the stack where the error message is created.

Consider some code that starts with a message, invokes some process that performs transformation on that message and then fails for some reason, throwing the exception. The exception is caught and an error message produced that contains both the original message, and the transformed message that failed.

Modifier and Type	Field and Description
private final Message<?>	originalMessage
private static final long	serialVersionUID Hides org.springframework.messaging.support.GenericMessage.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	ErrorMessage(Throwable the message payload (never `null`) payload) Create a new message with the given payload.
public	ErrorMessage(Throwable the message payload (never `null`) payload, Map<String, Object> message headers to use for initialization headers) Create a new message with the given payload and headers.
public	ErrorMessage(Throwable the message payload (never `null`) payload, MessageHeaders message headers headers) A constructor with the `MessageHeaders` instance to use.
public	ErrorMessage(Throwable the message payload (never `null`) payload, Message<?> the original message (if present) at the point in the stack where the ErrorMessage was created originalMessage) Create a new message with the given payload and original message.
public	ErrorMessage(Throwable the message payload (never `null`) payload, Map<String, Object> message headers to use for initialization headers, Message<?> the original message (if present) at the point in the stack where the ErrorMessage was created originalMessage) Create a new message with the given payload, headers and original message.
public	ErrorMessage(Throwable the message payload (never `null`) payload, MessageHeaders message headers headers, Message<?> the original message (if present) at the point in the stack where the ErrorMessage was created originalMessage) Create a new message with the payload, `MessageHeaders` and original message.

Method Summary

Modifier and Type	Method and Description
public Message<?>	getOriginalMessage() Return the original message (if available) at the point in the stack where the ErrorMessage was created.
public String	toString() Overrides org.springframework.messaging.support.GenericMessage.toString. Returns a string representation of the object.

Inherited from org.springframework.messaging.support.GenericMessage:: equals getHeaders getPayload hashCode

Field Detail

originalMessage	back to summary
private final Message<?> originalMessage Annotations @Nullable @SuppressWarnings:serial

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.springframework.messaging.support.GenericMessage.serialVersionUID.

Constructor Detail

ErrorMessage back to summary

ErrorMessage	back to summary
public ErrorMessage(Throwable payload) Create a new message with the given payload. Parameters payload:Throwable the message payload (never `null`)

public ErrorMessage(Throwable payload)

Create a new message with the given payload.

Parameters

payload:Throwable: the message payload (never null)

ErrorMessage back to summary

ErrorMessage	back to summary
public ErrorMessage(Throwable payload, Map<String, Object> headers) Create a new message with the given payload and headers. The content of the given header map is copied. Parameters payload:Throwable the message payload (never `null`) headers:Map<String, Object> message headers to use for initialization

public ErrorMessage(Throwable payload, Map<String, Object> headers)

Create a new message with the given payload and headers. The content of the given header map is copied.

Parameters

payload:Throwable: the message payload (never null)
headers:Map<String, Object>: message headers to use for initialization

ErrorMessage back to summary

ErrorMessage	back to summary
public ErrorMessage(Throwable payload, MessageHeaders headers) A constructor with the `MessageHeaders` instance to use. Note the given `MessageHeaders` instance is used directly in the new message, i.e. it is not copied. Parameters payload:Throwable the message payload (never `null`) headers:MessageHeaders message headers

public ErrorMessage(Throwable payload, MessageHeaders headers)

A constructor with the MessageHeaders instance to use.

Note

the given MessageHeaders instance is used directly in the new message, i.e. it is not copied.

Parameters

payload:Throwable: the message payload (never null)
headers:MessageHeaders: message headers

ErrorMessage back to summary

ErrorMessage	back to summary
public ErrorMessage(Throwable payload, Message<?> originalMessage) Create a new message with the given payload and original message. Parameters payload:Throwable the message payload (never `null`) originalMessage:Message<?> the original message (if present) at the point in the stack where the ErrorMessage was created Since 5.0

public ErrorMessage(Throwable payload, Message<?> originalMessage)

Create a new message with the given payload and original message.

Parameters

payload:Throwable: the message payload (never null)
originalMessage:Message<?>: the original message (if present) at the point in the stack where the ErrorMessage was created

Since

5.0

ErrorMessage back to summary

ErrorMessage	back to summary
public ErrorMessage(Throwable payload, Map<String, Object> headers, Message<?> originalMessage) Create a new message with the given payload, headers and original message. The content of the given header map is copied. Parameters payload:Throwable the message payload (never `null`) headers:Map<String, Object> message headers to use for initialization originalMessage:Message<?> the original message (if present) at the point in the stack where the ErrorMessage was created Since 5.0

public ErrorMessage(Throwable payload, Map<String, Object> headers, Message<?> originalMessage)

Create a new message with the given payload, headers and original message. The content of the given header map is copied.

Parameters

payload:Throwable: the message payload (never null)
headers:Map<String, Object>: message headers to use for initialization
originalMessage:Message<?>: the original message (if present) at the point in the stack where the ErrorMessage was created

Since

5.0

ErrorMessage back to summary

ErrorMessage	back to summary
public ErrorMessage(Throwable payload, MessageHeaders headers, Message<?> originalMessage) Create a new message with the payload, `MessageHeaders` and original message. Note the given `MessageHeaders` instance is used directly in the new message, i.e. it is not copied. Parameters payload:Throwable the message payload (never `null`) headers:MessageHeaders message headers originalMessage:Message<?> the original message (if present) at the point in the stack where the ErrorMessage was created Since 5.0

public ErrorMessage(Throwable payload, MessageHeaders headers, Message<?> originalMessage)

Create a new message with the payload, MessageHeaders and original message.

Note

the given MessageHeaders instance is used directly in the new message, i.e. it is not copied.

Parameters

payload:Throwable: the message payload (never null)
headers:MessageHeaders: message headers
originalMessage:Message<?>: the original message (if present) at the point in the stack where the ErrorMessage was created

Since

5.0

Method Detail

getOriginalMessage	back to summary
public Message<?> getOriginalMessage() Return the original message (if available) at the point in the stack where the ErrorMessage was created. Annotations @Nullable Since 5.0

getOriginalMessage

back to summary

public Message<?> getOriginalMessage()

Return the original message (if available) at the point in the stack where the ErrorMessage was created.

Annotations

@Nullable

Since

5.0

toString back to summary

toString	back to summary
public String toString() Overrides org.springframework.messaging.support.GenericMessage.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides org.springframework.messaging.support.GenericMessage.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class ErrorMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail