root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

ErrorMessage.toString() includes original message at top level 

Issue: SPR-15459
This commit is contained in:
Juergen Hoeller 2017-04-19 20:50:20 +02:00
parent c16c8f26f5
commit e93e49f268
2 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
spring-messaging/src/main/java/org/springframework/messaging/support/ErrorMessage.java
View File

@ -23,10 +23,12 @@ import org.springframework.messaging.MessageHeaders;
/** /**
* A {@link GenericMessage} with a {@link Throwable} payload. * A {@link GenericMessage} with a {@link Throwable} payload.
* The payload is typically a {@link org.springframework.messaging.MessagingException} *
* <p>The payload is typically a {@link org.springframework.messaging.MessagingException}
* with the message at the point of failure in its {@code failedMessage} property. * with the message at the point of failure in its {@code failedMessage} property.
* An optional {@code originalMessage} may be provided, which represents the message * An optional {@code originalMessage} may be provided, which represents the message
* that existed at the point in the stack where the error message is created. * that existed at the point in the stack where the error message is created.
*
* <p>Consider some code that starts with a message, invokes some process that performs * <p>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. * 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 * The exception is caught and an error message produced that contains both the original
@ -44,6 +46,7 @@ public class ErrorMessage extends GenericMessage<Throwable> {
private final Message<?> originalMessage; private final Message<?> originalMessage;
/** /**
* Create a new message with the given payload. * Create a new message with the given payload.
* @param payload the message payload (never {@code null}) * @param payload the message payload (never {@code null})
@ -79,8 +82,8 @@ public class ErrorMessage extends GenericMessage<Throwable> {
/** /**
* Create a new message with the given payload and original message. * Create a new message with the given payload and original message.
* @param payload the message payload (never {@code null}) * @param payload the message payload (never {@code null})
* @param originalMessage the original message (if present) at the point in the stack * @param originalMessage the original message (if present) at the point
* where the ErrorMessage was created * in the stack where the ErrorMessage was created
* @since 5.0 * @since 5.0
*/ */
public ErrorMessage(Throwable payload, Message<?> originalMessage) { public ErrorMessage(Throwable payload, Message<?> originalMessage) {
@ -93,8 +96,8 @@ public class ErrorMessage extends GenericMessage<Throwable> {
* The content of the given header map is copied. * The content of the given header map is copied.
* @param payload the message payload (never {@code null}) * @param payload the message payload (never {@code null})
* @param headers message headers to use for initialization * @param headers message headers to use for initialization
* @param originalMessage the original message (if present) at the point in the stack * @param originalMessage the original message (if present) at the point
* where the ErrorMessage was created * in the stack where the ErrorMessage was created
* @since 5.0 * @since 5.0
*/ */
public ErrorMessage(Throwable payload, Map<String, Object> headers, Message<?> originalMessage) { public ErrorMessage(Throwable payload, Map<String, Object> headers, Message<?> originalMessage) {
@ -108,8 +111,8 @@ public class ErrorMessage extends GenericMessage<Throwable> {
* is used directly in the new message, i.e. it is not copied. * is used directly in the new message, i.e. it is not copied.
* @param payload the message payload (never {@code null}) * @param payload the message payload (never {@code null})
* @param headers message headers * @param headers message headers
* @param originalMessage the original message (if present) at the point in the stack * @param originalMessage the original message (if present) at the point
* where the ErrorMessage was created * in the stack where the ErrorMessage was created
* @since 5.0 * @since 5.0
*/ */
public ErrorMessage(Throwable payload, MessageHeaders headers, Message<?> originalMessage) { public ErrorMessage(Throwable payload, MessageHeaders headers, Message<?> originalMessage) {
@ -117,13 +120,14 @@ public class ErrorMessage extends GenericMessage<Throwable> {
this.originalMessage = originalMessage; this.originalMessage = originalMessage;
} }
/** /**
* The original message (if present) at the point in the stack where the * Return the original message (if available) at the point in the stack
* ErrorMessage was created. * where the ErrorMessage was created.
* @return the originalMessage * @since 5.0
*/ */
public Message<?> getOriginalMessage() { public Message<?> getOriginalMessage() {
return originalMessage; return this.originalMessage;
} }
@Override @Override
@ -131,14 +135,10 @@ public class ErrorMessage extends GenericMessage<Throwable> {
if (this.originalMessage == null) { if (this.originalMessage == null) {
return super.toString(); return super.toString();
} }
else {
StringBuilder sb = new StringBuilder(super.toString()); StringBuilder sb = new StringBuilder(super.toString());
if (sb.length() > 0) { sb.append(" for original ").append(this.originalMessage);
sb.setLength(sb.length() - 1);
}
sb.append(", originalMessage=").append(this.originalMessage.toString()).append("]");
return sb.toString(); return sb.toString();
} }
}
} }

9
spring-messaging/src/test/java/org/springframework/messaging/support/ErrorMessageTests.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2017 the original author or authors. * Copyright 2002-2017 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -22,7 +22,6 @@ import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*; import static org.junit.Assert.*;
/** /**
*
* @author Gary Russell * @author Gary Russell
* @since 5.0 * @since 5.0
*/ */
@ -32,10 +31,12 @@ public class ErrorMessageTests {
public void testToString() { public void testToString() {
ErrorMessage em = new ErrorMessage(new RuntimeException("foo")); ErrorMessage em = new ErrorMessage(new RuntimeException("foo"));
String emString = em.toString(); String emString = em.toString();
assertThat(emString, not(containsString("originalMessage"))); assertThat(emString, not(containsString("original")));
em = new ErrorMessage(new RuntimeException("foo"), new GenericMessage<>("bar")); em = new ErrorMessage(new RuntimeException("foo"), new GenericMessage<>("bar"));
emString = em.toString(); emString = em.toString();
assertThat(emString, containsString("}, originalMessage=")); assertThat(emString, containsString("original"));
assertThat(emString, containsString(em.getOriginalMessage().toString()));
} }
} }