JmsMessagingTemplate uses local convertJmsException template method instead of generic MessagingExceptionTranslator interface

This commit also turns MessagingException into a NestedRuntimeException subclass which delivers a root message that has the cause message appended to it. That's a common expectation with the use of Spring exceptions since all of our exception hierarchies have historically been designed that way.

Issue: SPR-12064
Issue: SPR-12038

Author: jhoeller

spring-jms/src/main/java/org/springframework/jms/core/JmsMessagingTemplate.java

@@ -22,17 +22,17 @@
 import javax.jms.Session;
 
 import org.springframework.beans.factory.InitializingBean;
+import org.springframework.jms.InvalidDestinationException;
 import org.springframework.jms.JmsException;
-import org.springframework.jms.support.JmsMessagingExceptionTranslator;
 import org.springframework.jms.support.converter.MessageConverter;
 import org.springframework.jms.support.converter.MessagingMessageConverter;
 import org.springframework.jms.support.converter.SimpleMessageConverter;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessagingException;
 import org.springframework.messaging.converter.MessageConversionException;
 import org.springframework.messaging.core.AbstractMessagingTemplate;
+import org.springframework.messaging.core.DestinationResolutionException;
 import org.springframework.messaging.core.MessagePostProcessor;
-import org.springframework.messaging.support.MessagingExceptionTranslator;
 import org.springframework.util.Assert;
 
 /**
@@ -48,8 +48,6 @@ public class JmsMessagingTemplate extends AbstractMessagingTemplate<Destination>
 
 	private MessageConverter jmsMessageConverter = new MessagingMessageConverter();
 
-	private MessagingExceptionTranslator exceptionTranslator = new JmsMessagingExceptionTranslator();
-
 	private String defaultDestinationName;
 
 
@@ -80,7 +78,7 @@ public void setJmsTemplate(JmsTemplate jmsTemplate) {
 	 * Return the configured {@link JmsTemplate}.
 	 */
 	public JmsTemplate getJmsTemplate() {
-		return jmsTemplate;
+		return this.jmsTemplate;
 	}
 
 	/**
@@ -98,11 +96,11 @@ public void setJmsMessageConverter(MessageConverter jmsMessageConverter) {
 	}
 
 	/**
-	 * Set the {@link MessagingExceptionTranslator} to use. Default to
-	 * {@link JmsMessagingExceptionTranslator}.
+	 * Return the {@link MessageConverter} to use to convert a {@link Message}
+	 * from the messaging to and from a {@link javax.jms.Message}.
 	 */
-	public void setExceptionTranslator(MessagingExceptionTranslator exceptionTranslator) {
-		this.exceptionTranslator = exceptionTranslator;
+	public MessageConverter getJmsMessageConverter() {
+		return this.jmsMessageConverter;
 	}
 
 	/**
@@ -124,8 +122,8 @@ public String getDefaultDestinationName() {
 
 	@Override
 	public void afterPropertiesSet() {
-		Assert.notNull(this.jmsTemplate, "Property 'jmsTemplate' is required");
-		Assert.notNull(this.jmsMessageConverter, "Property 'jmsMessageConverter' is required");
+		Assert.notNull(getJmsTemplate(), "Property 'jmsTemplate' is required");
+		Assert.notNull(getJmsMessageConverter(), "Property 'jmsMessageConverter' is required");
 	}
 
 
@@ -295,7 +293,7 @@ protected void doSend(Destination destination, Message<?> message) {
 			this.jmsTemplate.send(destination, createMessageCreator(message));
 		}
 		catch (JmsException ex) {
-			throw translateIfNecessary(ex);
+			throw convertJmsException(ex);
 		}
 	}
 
@@ -304,28 +302,28 @@ protected void doSend(String destinationName, Message<?> message) {
 			this.jmsTemplate.send(destinationName, createMessageCreator(message));
 		}
 		catch (JmsException ex) {
-			throw translateIfNecessary(ex);
+			throw convertJmsException(ex);
 		}
 	}
 
 	@Override
 	protected Message<?> doReceive(Destination destination) {
 		try {
 			javax.jms.Message jmsMessage = this.jmsTemplate.receive(destination);
-			return doConvert(jmsMessage);
+			return convertJmsMessage(jmsMessage);
 		}
 		catch (JmsException ex) {
-			throw translateIfNecessary(ex);
+			throw convertJmsException(ex);
 		}
 	}
 
 	protected Message<?> doReceive(String destinationName) {
 		try {
 			javax.jms.Message jmsMessage = this.jmsTemplate.receive(destinationName);
-			return doConvert(jmsMessage);
+			return convertJmsMessage(jmsMessage);
 		}
 		catch (JmsException ex) {
-			throw translateIfNecessary(ex);
+			throw convertJmsException(ex);
 		}
 	}
 
@@ -334,26 +332,26 @@ protected Message<?> doSendAndReceive(Destination destination, Message<?> reques
 		try {
 			javax.jms.Message jmsMessage = this.jmsTemplate.sendAndReceive(
 					destination, createMessageCreator(requestMessage));
-			return doConvert(jmsMessage);
+			return convertJmsMessage(jmsMessage);
 		}
 		catch (JmsException ex) {
-			throw translateIfNecessary(ex);
+			throw convertJmsException(ex);
 		}
 	}
 
 	protected Message<?> doSendAndReceive(String destinationName, Message<?> requestMessage) {
 		try {
 			javax.jms.Message jmsMessage = this.jmsTemplate.sendAndReceive(
 					destinationName, createMessageCreator(requestMessage));
-			return doConvert(jmsMessage);
+			return convertJmsMessage(jmsMessage);
 		}
 		catch (JmsException ex) {
-			throw translateIfNecessary(ex);
+			throw convertJmsException(ex);
 		}
 	}
 
 	private MessagingMessageCreator createMessageCreator(Message<?> message) {
-		return new MessagingMessageCreator(message, this.jmsMessageConverter);
+		return new MessagingMessageCreator(message, getJmsMessageConverter());
 	}
 
 	protected String getRequiredDefaultDestinationName() {
@@ -365,25 +363,29 @@ protected String getRequiredDefaultDestinationName() {
 		return name;
 	}
 
-	protected Message<?> doConvert(javax.jms.Message message) {
+	protected Message<?> convertJmsMessage(javax.jms.Message message) {
 		if (message == null) {
 			return null;
 		}
 		try {
-			return (Message<?>) this.jmsMessageConverter.fromMessage(message);
-		}
-		catch (JMSException ex) {
-			throw new MessageConversionException("Could not convert '" + message + "'", ex);
+			return (Message<?>) getJmsMessageConverter().fromMessage(message);
 		}
-		catch (JmsException ex) {
+		catch (Exception ex) {
 			throw new MessageConversionException("Could not convert '" + message + "'", ex);
 		}
 	}
 
 	@SuppressWarnings("ThrowableResultOfMethodCallIgnored")
-	protected RuntimeException translateIfNecessary(RuntimeException rawException) {
-		MessagingException messagingException = this.exceptionTranslator.translateExceptionIfPossible(rawException);
-		return (messagingException != null ? messagingException : rawException);
+	protected MessagingException convertJmsException(JmsException ex) {
+		if (ex instanceof org.springframework.jms.support.destination.DestinationResolutionException ||
+				ex instanceof InvalidDestinationException) {
+			return new DestinationResolutionException(ex.getMessage(), ex);
+		}
+		if (ex instanceof org.springframework.jms.support.converter.MessageConversionException) {
+			return new MessageConversionException(ex.getMessage(), ex);
+		}
+		// Fallback
+		return new MessagingException(ex.getMessage(), ex);
 	}
 
 
@@ -403,10 +405,7 @@ public javax.jms.Message createMessage(Session session) throws JMSException {
 			try {
 				return this.messageConverter.toMessage(this.message, session);
 			}
-			catch (JMSException ex) {
-				throw new MessageConversionException("Could not convert '" + this.message + "'", ex);
-			}
-			catch (JmsException ex) {
+			catch (Exception ex) {
 				throw new MessageConversionException("Could not convert '" + this.message + "'", ex);
 			}
 		}

spring-jms/src/main/java/org/springframework/jms/support/JmsMessagingExceptionTranslator.java

@@ -26,6 +26,7 @@
 import javax.jms.Session;
 import javax.jms.TextMessage;
 
+import org.hamcrest.core.StringContains;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
@@ -47,14 +48,12 @@
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessagingException;
 import org.springframework.messaging.converter.GenericMessageConverter;
-import org.springframework.messaging.converter.MessageConversionException;
 import org.springframework.messaging.support.MessageBuilder;
 
 import static org.junit.Assert.*;
 import static org.mockito.BDDMockito.*;
 
 /**
- *
  * @author Stephane Nicoll
  */
 public class JmsMessagingTemplateTests {
@@ -193,16 +192,16 @@ public void convertAndSendCustomJmsMessageConverter() throws JMSException {
 		messagingTemplate.setJmsMessageConverter(new SimpleMessageConverter() {
 			@Override
 			public javax.jms.Message toMessage(Object object, Session session)
-					throws JMSException, MessageConversionException {
-				throw new MessageConversionException("Test exception");
+					throws JMSException, org.springframework.jms.support.converter.MessageConversionException {
+				throw new org.springframework.jms.support.converter.MessageConversionException("Test exception");
 			}
 		});
 
 		messagingTemplate.convertAndSend("myQueue", "msg to convert");
 		verify(jmsTemplate).send(eq("myQueue"), messageCreator.capture());
 
-		thrown.expect(MessageConversionException.class);
-		thrown.expectMessage("Test exception");
+		thrown.expect(org.springframework.messaging.converter.MessageConversionException.class);
+		thrown.expectMessage(new StringContains("Test exception"));
 		messageCreator.getValue().createMessage(mock(Session.class));
 	}
 

spring-jms/src/test/java/org/springframework/jms/core/JmsMessagingTemplateTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,8 @@
 
 package org.springframework.messaging;
 
+import org.springframework.core.NestedRuntimeException;
+
 /**
  * The base exception for any failures related to messaging.
  *
@@ -24,13 +26,13 @@
  * @since 4.0
  */
 @SuppressWarnings("serial")
-public class MessagingException extends RuntimeException {
+public class MessagingException extends NestedRuntimeException {
 
 	private final Message<?> failedMessage;
 
 
 	public MessagingException(Message<?> message) {
-		super();
+		super("");
 		this.failedMessage = message;
 	}
 
@@ -50,7 +52,7 @@ public MessagingException(Message<?> message, String description) {
 	}
 
 	public MessagingException(Message<?> message, Throwable cause) {
-		super(cause);
+		super("", cause);
 		this.failedMessage = message;
 	}