Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MessageConversionException offers constructor without cause argument now, plus related polishing

Browse Source 
Issue: SPR-11653
(cherry picked from commit 2888775)
This commit is contained in:
Juergen Hoeller
2014-04-17 21:19:37 +02:00
parent 090ab4bb6d
commit 02e8198283
6 changed files with 95 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-messaging/src/main/java/org/springframework/messaging/converter/MessageConversionException.java
View File

@@ -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.
@@ -28,6 +28,9 @@ import org.springframework.messaging.MessagingException;
@SuppressWarnings("serial")
public class MessageConversionException extends MessagingException {
public MessageConversionException(String description) {
super(description);
}
public MessageConversionException(String description, Throwable cause) {
super(description, cause);

25
spring-messaging/src/main/java/org/springframework/messaging/core/AbstractDestinationResolvingMessagingTemplate.java
View File

@@ -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.
@@ -25,9 +25,9 @@ import org.springframework.util.Assert;
* An extension of {@link AbstractMessagingTemplate} that adds operations for sending
* messages to a resolvable destination name as defined by the following interfaces:
* <ul>
* <li>{@link DestinationResolvingMessageSendingOperations}</li>
* <li>{@link DestinationResolvingMessageReceivingOperations}</li>
* <li>{@link DestinationResolvingMessageRequestReplyOperations}</li>
* <li>{@link DestinationResolvingMessageSendingOperations}</li>
* <li>{@link DestinationResolvingMessageReceivingOperations}</li>
* <li>{@link DestinationResolvingMessageRequestReplyOperations}</li>
* </ul>
*
* @author Mark Fisher
@@ -65,36 +65,31 @@ public abstract class AbstractDestinationResolvingMessagingTemplate<D> extends A
@Override
public void send(String destinationName, Message<?> message) {
D destination = resolveDestination(destinationName);
this.doSend(destination, message);
doSend(destination, message);
}
protected final D resolveDestination(String destinationName) {
Assert.state(this.destinationResolver != null, "destinationResolver is required to resolve destination names");
Assert.state(this.destinationResolver != null, "DestinationResolver is required to resolve destination names");
return this.destinationResolver.resolveDestination(destinationName);
}
@Override
public <T> void convertAndSend(String destinationName, T payload) {
Map<String, Object> headers = null;
this.convertAndSend(destinationName, payload, headers);
convertAndSend(destinationName, payload, null, null);
}
@Override
public <T> void convertAndSend(String destinationName, T payload, Map<String, Object> headers) {
MessagePostProcessor postProcessor = null;
this.convertAndSend(destinationName, payload, headers, postProcessor);
convertAndSend(destinationName, payload, headers, null);
}
@Override
public <T> void convertAndSend(String destinationName, T payload, MessagePostProcessor postProcessor) {
Map<String, Object> headers = null;
this.convertAndSend(destinationName, payload, headers, postProcessor);
convertAndSend(destinationName, payload, null, postProcessor);
}
@Override
public <T> void convertAndSend(String destinationName, T payload, Map<String, Object> headers,
MessagePostProcessor postProcessor) {
public <T> void convertAndSend(String destinationName, T payload, Map<String, Object> headers, MessagePostProcessor postProcessor) {
D destination = resolveDestination(destinationName);
super.convertAndSend(destination, payload, headers, postProcessor);
}

49
spring-messaging/src/main/java/org/springframework/messaging/core/AbstractMessageSendingTemplate.java
View File

@@ -20,6 +20,7 @@ import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageHeaders;
import org.springframework.messaging.MessagingException;
@@ -37,7 +38,7 @@ import org.springframework.util.Assert;
*/
public abstract class AbstractMessageSendingTemplate<D> implements MessageSendingOperations<D> {
protected final Log logger = LogFactory.getLog(this.getClass());
protected final Log logger = LogFactory.getLog(getClass());
private volatile D defaultDestination;
@@ -80,17 +81,17 @@ public abstract class AbstractMessageSendingTemplate<D> implements MessageSendin
@Override
public void send(Message<?> message) {
this.send(getRequiredDefaultDestination(), message);
send(getRequiredDefaultDestination(), message);
}
protected final D getRequiredDefaultDestination() {
Assert.state(this.defaultDestination != null, "No 'defaultDestination' configured.");
Assert.state(this.defaultDestination != null, "No 'defaultDestination' configured");
return this.defaultDestination;
}
@Override
public void send(D destination, Message<?> message) {
this.doSend(destination, message);
doSend(destination, message);
}
protected abstract void doSend(D destination, Message<?> message);
@@ -98,61 +99,57 @@ public abstract class AbstractMessageSendingTemplate<D> implements MessageSendin
@Override
public void convertAndSend(Object payload) throws MessagingException {
this.convertAndSend(getRequiredDefaultDestination(), payload);
convertAndSend(getRequiredDefaultDestination(), payload);
}
@Override
public void convertAndSend(D destination, Object payload) throws MessagingException {
this.convertAndSend(destination, payload, (Map<String, Object>) null);
convertAndSend(destination, payload, (Map<String, Object>) null);
}
@Override
public void convertAndSend(D destination, Object payload, Map<String, Object> headers) throws MessagingException {
MessagePostProcessor postProcessor = null;
this.convertAndSend(destination, payload, headers, postProcessor);
convertAndSend(destination, payload, headers, null);
}
@Override
public void convertAndSend(Object payload, MessagePostProcessor postProcessor) throws MessagingException {
this.convertAndSend(getRequiredDefaultDestination(), payload, postProcessor);
convertAndSend(getRequiredDefaultDestination(), payload, postProcessor);
}
@Override
public void convertAndSend(D destination, Object payload, MessagePostProcessor postProcessor)
throws MessagingException {
Map<String, Object> headers = null;
this.convertAndSend(destination, payload, headers, postProcessor);
convertAndSend(destination, payload, null, postProcessor);
}
@Override
public void convertAndSend(D destination, Object payload, Map<String, Object> headers,
MessagePostProcessor postProcessor) throws MessagingException {
headers = processHeadersToSend(headers);
MessageHeaders messageHeaders = (headers != null) ? new MessageHeaders(headers) : null;
Message<?> message = this.converter.toMessage(payload, messageHeaders);
Map<String, Object> headersToUse = processHeadersToSend(headers);
MessageHeaders messageHeaders = (headersToUse != null ? new MessageHeaders(headersToUse) : null);
Message<?> message = getMessageConverter().toMessage(payload, messageHeaders);
if (message == null) {
String payloadType = (payload != null) ? payload.getClass().getName() : null;
throw new MessageConversionException("Unable to convert payload type '"
+ payloadType + "', Content-Type=" + messageHeaders.get(MessageHeaders.CONTENT_TYPE)
+ ", converter=" + this.converter, null);
String payloadType = (payload != null ? payload.getClass().getName() : null);
Object contentType = (messageHeaders != null ? messageHeaders.get(MessageHeaders.CONTENT_TYPE) : null);
throw new MessageConversionException("Unable to convert payload with type='" + payloadType +
"', contentType='" + contentType + "', converter=[" + getMessageConverter() + "]");
}
if (postProcessor != null) {
message = postProcessor.postProcessMessage(message);
}
this.send(destination, message);
send(destination, message);
}
/**
* Provides access to the map of headers before a send operation.
* Implementations can modify the headers by returning a different map.
* This implementation returns the map that was passed in (i.e. without any changes).
*
* @param headers the headers to send, possibly {@code null}
* @return the actual headers to send
* Provides access to the map of input headers before a send operation. Sub-classes
* can modify the headers and then return the same or a different map.
* <p>This default implementation in this class returns the input map.
* @param headers the headers to send or {@code null}
* @return the actual headers to send or {@code null}
*/
protected Map<String, Object> processHeadersToSend(Map<String, Object> headers) {
return headers;

47
spring-messaging/src/main/java/org/springframework/messaging/core/AbstractMessagingTemplate.java
View File

@@ -37,12 +37,12 @@ public abstract class AbstractMessagingTemplate<D> extends AbstractMessageSendin
@Override
public Message<?> receive() {
return this.receive(getRequiredDefaultDestination());
return receive(getRequiredDefaultDestination());
}
@Override
public Message<?> receive(D destination) {
return this.doReceive(destination);
return doReceive(destination);
}
protected abstract Message<?> doReceive(D destination);
@@ -50,13 +50,13 @@ public abstract class AbstractMessagingTemplate<D> extends AbstractMessageSendin
@Override
public <T> T receiveAndConvert(Class<T> targetClass) {
return this.receiveAndConvert(getRequiredDefaultDestination(), targetClass);
return receiveAndConvert(getRequiredDefaultDestination(), targetClass);
}
@SuppressWarnings("unchecked")
@Override
public <T> T receiveAndConvert(D destination, Class<T> targetClass) {
Message<?> message = this.doReceive(destination);
Message<?> message = doReceive(destination);
if (message != null) {
return (T) getMessageConverter().fromMessage(message, targetClass);
}
@@ -67,12 +67,12 @@ public abstract class AbstractMessagingTemplate<D> extends AbstractMessageSendin
@Override
public Message<?> sendAndReceive(Message<?> requestMessage) {
return this.sendAndReceive(getRequiredDefaultDestination(), requestMessage);
return sendAndReceive(getRequiredDefaultDestination(), requestMessage);
}
@Override
public Message<?> sendAndReceive(D destination, Message<?> requestMessage) {
return this.doSendAndReceive(destination, requestMessage);
return doSendAndReceive(destination, requestMessage);
}
protected abstract Message<?> doSendAndReceive(D destination, Message<?> requestMessage);
@@ -80,34 +80,27 @@ public abstract class AbstractMessagingTemplate<D> extends AbstractMessageSendin
@Override
public <T> T convertSendAndReceive(Object request, Class<T> targetClass) {
return this.convertSendAndReceive(getRequiredDefaultDestination(), request, targetClass);
return convertSendAndReceive(getRequiredDefaultDestination(), request, targetClass);
}
@Override
public <T> T convertSendAndReceive(D destination, Object request, Class<T> targetClass) {
Map<String, Object> headers = null;
return this.convertSendAndReceive(destination, request, headers, targetClass);
return convertSendAndReceive(destination, request, null, targetClass);
}
@Override
public <T> T convertSendAndReceive(D destination, Object request, Map<String, Object> headers,
Class<T> targetClass) {
MessagePostProcessor postProcessor = null;
return this.convertSendAndReceive(destination, request, headers, targetClass, postProcessor);
public <T> T convertSendAndReceive(D destination, Object request, Map<String, Object> headers, Class<T> targetClass) {
return convertSendAndReceive(destination, request, headers, targetClass, null);
}
@Override
public <T> T convertSendAndReceive(Object request, Class<T> targetClass, MessagePostProcessor postProcessor) {
return this.convertSendAndReceive(getRequiredDefaultDestination(), request, targetClass, postProcessor);
return convertSendAndReceive(getRequiredDefaultDestination(), request, targetClass, postProcessor);
}
@Override
public <T> T convertSendAndReceive(D destination, Object request, Class<T> targetClass,
MessagePostProcessor postProcessor) {
Map<String, Object> headers = null;
return this.convertSendAndReceive(destination, request, headers, targetClass, postProcessor);
public <T> T convertSendAndReceive(D destination, Object request, Class<T> targetClass, MessagePostProcessor postProcessor) {
return convertSendAndReceive(destination, request, null, targetClass, postProcessor);
}
@SuppressWarnings("unchecked")
@@ -115,22 +108,22 @@ public abstract class AbstractMessagingTemplate<D> extends AbstractMessageSendin
public <T> T convertSendAndReceive(D destination, Object request, Map<String, Object> headers,
Class<T> targetClass, MessagePostProcessor postProcessor) {
MessageHeaders messageHeaders = (headers != null) ? new MessageHeaders(headers) : null;
MessageHeaders messageHeaders = (headers != null ? new MessageHeaders(headers) : null);
Message<?> requestMessage = getMessageConverter().toMessage(request, messageHeaders);
if (requestMessage == null) {
String payloadType = (request != null) ? request.getClass().getName() : null;
throw new MessageConversionException("Unable to convert payload type '"
+ payloadType + "', Content-Type=" + messageHeaders.get(MessageHeaders.CONTENT_TYPE)
+ ", converter=" + getMessageConverter(), null);
String payloadType = (request != null ? request.getClass().getName() : null);
Object contentType = (messageHeaders != null ? messageHeaders.get(MessageHeaders.CONTENT_TYPE) : null);
throw new MessageConversionException("Unable to convert payload with type '" + payloadType +
"', contentType='" + contentType + "', converter=[" + getMessageConverter() + "]");
}
if (postProcessor != null) {
requestMessage = postProcessor.postProcessMessage(requestMessage);
}
Message<?> replyMessage = this.sendAndReceive(destination, requestMessage);
return (replyMessage != null) ? (T) getMessageConverter().fromMessage(replyMessage, targetClass) : null;
Message<?> replyMessage = sendAndReceive(destination, requestMessage);
return (replyMessage != null ? (T) getMessageConverter().fromMessage(replyMessage, targetClass) : null);
}
}

38
spring-messaging/src/main/java/org/springframework/messaging/core/GenericMessagingTemplate.java
View File

@@ -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.
@@ -53,7 +53,6 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
/**
* Configure the timeout value to use for send operations.
*
* @param sendTimeout the send timeout in milliseconds
*/
public void setSendTimeout(long sendTimeout) {
@@ -69,7 +68,6 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
/**
* Configure the timeout value to use for receive operations.
*
* @param receiveTimeout the receive timeout in milliseconds
*/
public void setReceiveTimeout(long receiveTimeout) {
@@ -88,11 +86,9 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
* receiving thread isn't going to receive the reply either because it timed out,
* or because it already received a reply, or because it got an exception while
* sending the request message.
* <p>
* The default value is {@code false} in which case only a WARN message is logged.
* <p>The default value is {@code false} in which case only a WARN message is logged.
* If set to {@code true} a {@link MessageDeliveryException} is raised in addition
* to the log message.
*
* @param throwExceptionOnLateReply whether to throw an exception or not
*/
public void setThrowExceptionOnLateReply(boolean throwExceptionOnLateReply) {
@@ -107,11 +103,10 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
@Override
protected final void doSend(MessageChannel channel, Message<?> message) {
Assert.notNull(channel, "channel must not be null");
Assert.notNull(channel, "'channel' is required");
long timeout = this.sendTimeout;
boolean sent = (timeout >= 0) ? channel.send(message, timeout) : channel.send(message);
boolean sent = (timeout >= 0 ? channel.send(message, timeout) : channel.send(message));
if (!sent) {
throw new MessageDeliveryException(message,
@@ -121,15 +116,14 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
@Override
protected final Message<?> doReceive(MessageChannel channel) {
Assert.notNull(channel, "'channel' is required");
Assert.state(channel instanceof PollableChannel, "A PollableChannel is required to receive messages.");
Assert.state(channel instanceof PollableChannel, "A PollableChannel is required to receive messages");
long timeout = this.receiveTimeout;
Message<?> message = (timeout >= 0) ?
((PollableChannel) channel).receive(timeout) : ((PollableChannel) channel).receive();
Message<?> message = (timeout >= 0 ?
((PollableChannel) channel).receive(timeout) : ((PollableChannel) channel).receive());
if ((message == null) && this.logger.isTraceEnabled()) {
if (message == null && this.logger.isTraceEnabled()) {
this.logger.trace("Failed to receive message from channel '" + channel + "' within timeout: " + timeout);
}
@@ -138,20 +132,16 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
@Override
protected final Message<?> doSendAndReceive(MessageChannel channel, Message<?> requestMessage) {
Assert.notNull(channel, "'channel' is required");
Object originalReplyChannelHeader = requestMessage.getHeaders().getReplyChannel();
Object originalErrorChannelHeader = requestMessage.getHeaders().getErrorChannel();
TemporaryReplyChannel tempReplyChannel = new TemporaryReplyChannel();
requestMessage = MessageBuilder.fromMessage(requestMessage)
.setReplyChannel(tempReplyChannel)
.setErrorChannel(tempReplyChannel).build();
requestMessage = MessageBuilder.fromMessage(requestMessage).setReplyChannel(tempReplyChannel).
setErrorChannel(tempReplyChannel).build();
try {
this.doSend(channel, requestMessage);
doSend(channel, requestMessage);
}
catch (RuntimeException e) {
tempReplyChannel.setSendFailed(true);
@@ -177,10 +167,10 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
private final Log logger = LogFactory.getLog(TemporaryReplyChannel.class);
private volatile Message<?> replyMessage;
private final CountDownLatch replyLatch = new CountDownLatch(1);
private volatile Message<?> replyMessage;
private volatile boolean hasReceived;
private volatile boolean hasTimedOut;
@@ -192,7 +182,6 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
this.hasSendFailed = hasSendError;
}
@Override
public Message<?> receive() {
return this.receive(-1);
@@ -227,7 +216,6 @@ public class GenericMessagingTemplate extends AbstractDestinationResolvingMessag
@Override
public boolean send(Message<?> message, long timeout) {
this.replyMessage = message;
boolean alreadyReceivedReply = this.hasReceived;
this.replyLatch.countDown();

57
spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessagingTemplate.java
View File

@@ -65,6 +65,13 @@ public class SimpMessagingTemplate extends AbstractMessageSendingTemplate<String
}
/**
* Return the configured message channel.
*/
public MessageChannel getMessageChannel() {
return this.messageChannel;
}
/**
* Configure the prefix to use for destinations targeting a specific user.
* <p>The default value is "/user/".
@@ -76,30 +83,21 @@ public class SimpMessagingTemplate extends AbstractMessageSendingTemplate<String
}
/**
* @return the userDestinationPrefix
* Return the configured user destination prefix.
*/
public String getUserDestinationPrefix() {
return this.userDestinationPrefix;
}
/**
* @return the messageChannel
*/
public MessageChannel getMessageChannel() {
return this.messageChannel;
}
/**
* Specify the timeout value to use for send operations.
*
* @param sendTimeout the send timeout in milliseconds
* Specify the timeout value to use for send operations (in milliseconds).
*/
public void setSendTimeout(long sendTimeout) {
this.sendTimeout = sendTimeout;
}
/**
* @return the sendTimeout
* Return the configured send timeout (in milliseconds).
*/
public long getSendTimeout() {
return this.sendTimeout;
@@ -124,13 +122,11 @@ public class SimpMessagingTemplate extends AbstractMessageSendingTemplate<String
message = MessageBuilder.withPayload(message.getPayload()).setHeaders(headers).build();
long timeout = this.sendTimeout;
boolean sent = (timeout >= 0)
? this.messageChannel.send(message, timeout)
: this.messageChannel.send(message);
boolean sent = (timeout >= 0 ? this.messageChannel.send(message, timeout) : this.messageChannel.send(message));
if (!sent) {
throw new MessageDeliveryException(message,
"failed to send message to destination '" + destination + "' within timeout: " + timeout);
"Failed to send message to destination '" + destination + "' within timeout: " + timeout);
}
}
@@ -138,21 +134,21 @@ public class SimpMessagingTemplate extends AbstractMessageSendingTemplate<String
@Override
public void convertAndSendToUser(String user, String destination, Object payload) throws MessagingException {
this.convertAndSendToUser(user, destination, payload, (MessagePostProcessor) null);
convertAndSendToUser(user, destination, payload, (MessagePostProcessor) null);
}
@Override
public void convertAndSendToUser(String user, String destination, Object payload,
Map<String, Object> headers) throws MessagingException {
this.convertAndSendToUser(user, destination, payload, headers, null);
convertAndSendToUser(user, destination, payload, headers, null);
}
@Override
public void convertAndSendToUser(String user, String destination, Object payload,
MessagePostProcessor postProcessor) throws MessagingException {
this.convertAndSendToUser(user, destination, payload, null, postProcessor);
convertAndSendToUser(user, destination, payload, null, postProcessor);
}
@Override
@@ -169,31 +165,28 @@ public class SimpMessagingTemplate extends AbstractMessageSendingTemplate<String
* {@link org.springframework.messaging.support.NativeMessageHeaderAccessor#NATIVE_HEADERS NATIVE_HEADERS}.
* Effectively this treats all given headers as headers to be sent out to the
* external source.
* <p>
* If the given headers already contain the key
* <p>If the given headers already contain the key
* {@link org.springframework.messaging.support.NativeMessageHeaderAccessor#NATIVE_HEADERS NATIVE_HEADERS}
* then the same header map is returned (i.e. without any changes).
*/
@Override
protected Map<String, Object> processHeadersToSend(Map<String, Object> headers) {
if (headers == null) {
return null;
}
else if (headers.containsKey(NativeMessageHeaderAccessor.NATIVE_HEADERS)) {
if (headers.containsKey(NativeMessageHeaderAccessor.NATIVE_HEADERS)) {
return headers;
}
else {
MultiValueMap<String, String> nativeHeaders = new LinkedMultiValueMap<String, String>(headers.size());
for (String key : headers.keySet()) {
Object value = headers.get(key);
nativeHeaders.set(key, (value != null ? value.toString() : null));
}
headers = new HashMap<String, Object>(1);
headers.put(NativeMessageHeaderAccessor.NATIVE_HEADERS, nativeHeaders);
return headers;
MultiValueMap<String, String> nativeHeaders = new LinkedMultiValueMap<String, String>(headers.size());
for (String key : headers.keySet()) {
Object value = headers.get(key);
nativeHeaders.set(key, (value != null ? value.toString() : null));
}
headers = new HashMap<String, Object>(1);
headers.put(NativeMessageHeaderAccessor.NATIVE_HEADERS, nativeHeaders);
return headers;
}
}