JmsUtils.buildExceptionMessage throws NPE if the linked exception doesn't have a message [SPR-5275]

[spring-projects-issues]

Anders Wallgren opened SPR-5275 and commented

This method throws an exception if the linked exception's message is null. I've patched it locally as follow:

/**
 * Build a descriptive exception message for the given JMSException,
 * incorporating a linked exception's message if appropriate.
 * @param ex the JMSException to build a message for
 * @return the descriptive message String
 * @see javax.jms.JMSException#getLinkedException()
 */
public static String buildExceptionMessage(JMSException ex) {
	String message = ex.getMessage();
	Exception linkedEx = ex.getLinkedException();
	if (linkedEx != null && (linkedEx.getMessage() == null || message.indexOf(linkedEx.getMessage()) == -1)) {
		message = message + "; nested exception is " + linkedEx;
	}
	return message;
}

---

Affects: 2.5.6

Issue Links:

• JmsException.getMessage throws NPE if a cause doesn't have a message [SPR-5332] #10005 JmsException.getMessage throws NPE if a cause doesn't have a message ("is duplicated by")
• NullPointerException in JmsException [SPR-5402] #10075 NullPointerException in JmsException ("is duplicated by")
• NullPointerException in JmsUtils.buildExceptionMessage [SPR-5785] #10455 NullPointerException in JmsUtils.buildExceptionMessage ("is duplicated by")
• NullPointerException in JmsUtils.buildExceptionMessage() [SPR-5958] #10626 NullPointerException in JmsUtils.buildExceptionMessage() ("is duplicated by")
• NullPointerException can occur from JmsUtils.buildException [SPR-6052] #10721 NullPointerException can occur from JmsUtils.buildException ("is duplicated by")
• Possible NPE in JmsUtils.buildExceptionMessage and JmsException.getMessage [SPR-5470] #10143 Possible NPE in JmsUtils.buildExceptionMessage and JmsException.getMessage ("is duplicated by")

[spring-projects-issues]

Juergen Hoeller commented

Thanks for pointing this out!

Juergen

[spring-projects-issues]

Guillaume Nodet commented

JmsException.getMessage() can also throw an NPE if the linked exception has no message.
This problem has not been fixed as part of this bug.

[spring-projects-issues]

Guillaume Nodet commented

The current code will throw an NPE if cause.getMessage() returns null.

        public String getMessage() {
 	                String message = super.getMessage();
 	                Throwable cause = getCause();
 	                if (cause instanceof JMSException) {
 	                        Exception linkedEx = ((JMSException) cause).getLinkedException();
 	                        if (linkedEx != null && cause.getMessage().indexOf(linkedEx.getMessage()) == -1) {
 	                                message = message + "; nested exception is " + linkedEx;
 	                        }
 	                }
 	                return message;
 	        }

[spring-projects-issues]

Karim Qazi commented

Looking at the 3.0M1 code this isn't totally fixed. Here is the code I see in the 3.0M1 code base:

public static String buildExceptionMessage(JMSException ex) {
     String message = ex.getMessage();
     Exception linkedEx = ex.getLinkedException();
     if (linkedEx != null) {
          if (message == null) {
               message = linkedEx.toString();
          }
          else if (!message.contains(linkedEx.getMessage())) {  // NPE could still happen here on the contains()
               message = message + "; nested exception is " + linkedEx;
          }
     }
     return message;
}

A null check for "linkedEx.getMessage()" needs to happen or else a NPE can still occur in "!message.contains(linkedEx.getMessage())". This is coded like "someString".equals(null) which will not throw a NPE, but "someString".contains(null) will throw a NPE.

[spring-projects-issues]

Juergen Hoeller commented

Karim,

That additional not-null check is indeed necessary. Fortunately, it's in there since 3.0 M2 already.

Juergen

[spring-projects-issues]

Karim Qazi commented

Ok thanks. When is 3.0 scheduled for release?