Interface MessageConverter
- All Known Subinterfaces:
SmartMessageConverter
- All Known Implementing Classes:
AbstractMessageConverter
,ByteArrayMessageConverter
,CompositeMessageConverter
,GenericMessageConverter
,MappingJackson2MessageConverter
,MarshallingMessageConverter
,SimpleMessageConverter
,StringMessageConverter
public interface MessageConverter
A converter to turn the payload of aMessage
from serialized form to a typed Object and vice versa. TheMessageHeaders.CONTENT_TYPE
message header may be used to specify the media type of the message content.- Since:
- 4.0
- Author:
- Mark Fisher, Rossen Stoyanchev
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Object
fromMessage(Message<?> message, Class<?> targetClass)
Convert the payload of aMessage
from a serialized form to a typed Object of the specified target class.Message<?>
toMessage(Object payload, MessageHeaders headers)
Create aMessage
whose payload is the result of converting the given payload Object to serialized form.
Method Detail
fromMessage
Object fromMessage(Message<?> message, Class<?> targetClass)
Convert the payload of aMessage
from a serialized form to a typed Object of the specified target class. TheMessageHeaders.CONTENT_TYPE
header should indicate the MIME type to convert from.If the converter does not support the specified media type or cannot perform the conversion, it should return
null
.- Parameters:
message
- the input messagetargetClass
- the target class for the conversion- Returns:
- the result of the conversion, or
null
if the converter cannot perform the conversion
toMessage
Message<?> toMessage(Object payload, MessageHeaders headers)
Create aMessage
whose payload is the result of converting the given payload Object to serialized form. The optionalMessageHeaders
parameter may contain aMessageHeaders.CONTENT_TYPE
header to specify the target media type for the conversion and it may contain additional headers to be added to the message.If the converter does not support the specified media type or cannot perform the conversion, it should return
null
.- Parameters:
payload
- the Object to convertheaders
- optional headers for the message (may benull
)- Returns:
- the new message, or
null
if the converter does not support the Object type or the target media type