Class SimpleMessageConverter
- java.lang.Object
- org.springframework.messaging.converter.SimpleMessageConverter
- All Implemented Interfaces:
MessageConverter
- Direct Known Subclasses:
GenericMessageConverter
public class SimpleMessageConverter extends Object implements MessageConverter
A simple converter that simply unwraps the message payload as long as it matches the expected target class. Or reversely, simply wraps the payload in a message.Note that this converter ignores any content type information that may be present in message headers and should not be used if payload conversion is actually required.
- Since:
- 4.0
- Author:
- Rossen Stoyanchev
Constructor Summary
Constructors Constructor Description SimpleMessageConverter()
Method Summary
All Methods Instance Methods Concrete 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.
Constructor Detail
SimpleMessageConverter
public SimpleMessageConverter()
Method Detail
fromMessage
public Object fromMessage(Message<?> message, Class<?> targetClass)
Description copied from interface:MessageConverter
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
.- Specified by:
fromMessage
in interfaceMessageConverter
- 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
public Message<?> toMessage(Object payload, MessageHeaders headers)
Description copied from interface:MessageConverter
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
.- Specified by:
toMessage
in interfaceMessageConverter
- 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