Interface SmartMessageConverter

All Superinterfaces:

MessageConverter

All Known Implementing Classes:

JacksonJsonMessageConverter, MappingJackson2MessageConverter

public interface SmartMessageConverter
extends MessageConverter

An extended MessageConverter SPI with conversion hint support.

In case of a conversion hint being provided, the framework will call the extended method if a converter implements this interface, instead of calling the regular toMessage variant.

Since:

4.3

Author:

Stephane Nicoll

Method Summary

Modifier and Type	Method	Description
jakarta.jms.Message	toMessage(Object object, jakarta.jms.Session session, @Nullable Object conversionHint)	A variant of MessageConverter.toMessage(Object, Session) which takes an extra conversion context as an argument, allowing to take, for example, annotations on a payload parameter into account.

Methods inherited from interface MessageConverter

fromMessage, toMessage

Method Details

toMessage

jakarta.jms.Message toMessage(Object object,
 jakarta.jms.Session session,
 @Nullable Object conversionHint)
                       throws jakarta.jms.JMSException,
MessageConversionException

A variant of MessageConverter.toMessage(Object, Session) which takes an extra conversion context as an argument, allowing to take, for example, annotations on a payload parameter into account.

Parameters:

object - the object to convert

session - the Session to use for creating a JMS Message

conversionHint - an extra object passed to the MessageConverter, for example, the associated MethodParameter (may be null)

Returns:

the JMS Message

Throws:

jakarta.jms.JMSException - if thrown by JMS API methods

MessageConversionException - in case of conversion failure

See Also:

• MessageConverter.toMessage(Object, Session)