Class JacksonProjectingMessageConverter

java.lang.Object

org.springframework.kafka.support.converter.MessagingMessageConverter

org.springframework.kafka.support.converter.JacksonProjectingMessageConverter

All Implemented Interfaces:

MessageConverter, RecordMessageConverter

public class JacksonProjectingMessageConverter
extends MessagingMessageConverter

A MessageConverter implementation based on Jackson3 uses a Spring Data ProjectionFactory to bind incoming messages to projection interfaces.

Since:

4.0

Author:

Oliver Gierke, Artem Bilan, Gary Russell, Soby Chacko

Field Summary

Fields inherited from class org.springframework.kafka.support.converter.MessagingMessageConverter

logger

Constructor Summary

Constructors

Constructor	Description
JacksonProjectingMessageConverter()	Create a new JacksonProjectingMessageConverter using a JacksonMapperUtils.enhancedJsonMapper() by default.
JacksonProjectingMessageConverter(MessagingMessageConverter delegate)	Create a new JacksonProjectingMessageConverter using the given JsonMapper.
JacksonProjectingMessageConverter(tools.jackson.databind.json.JsonMapper mapper)	Create a new JacksonProjectingMessageConverter using the given JsonMapper.
JacksonProjectingMessageConverter(tools.jackson.databind.json.JsonMapper mapper, MessagingMessageConverter delegate)	Create a new JacksonProjectingMessageConverter using the given JsonMapper.

Method Summary

Modifier and Type	Method	Description
protected @Nullable Object	convertPayload(Message<?> message)	Subclasses can convert the payload; by default, it's sent unchanged to Kafka.
protected Object	extractAndConvertValue(org.apache.kafka.clients.consumer.ConsumerRecord<?,?> record, @Nullable Type type)	Subclasses can convert the value; by default, it's returned as provided by Kafka unless there is a SmartMessageConverter that can convert it.

Methods inherited from class org.springframework.kafka.support.converter.MessagingMessageConverter

fromMessage, getMessagingConverter, initialRecordHeaders, setGenerateMessageId, setGenerateTimestamp, setHeaderMapper, setMessagingConverter, setRawRecordHeader, toMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.kafka.support.converter.MessageConverter

commonHeaders

Constructor Details

JacksonProjectingMessageConverter

public JacksonProjectingMessageConverter()

Create a new JacksonProjectingMessageConverter using a JacksonMapperUtils.enhancedJsonMapper() by default.

JacksonProjectingMessageConverter

public JacksonProjectingMessageConverter(tools.jackson.databind.json.JsonMapper mapper)

Create a new JacksonProjectingMessageConverter using the given JsonMapper.

Parameters:

mapper - must not be null.

JacksonProjectingMessageConverter

public JacksonProjectingMessageConverter(MessagingMessageConverter delegate)

Create a new JacksonProjectingMessageConverter using the given JsonMapper.

Parameters:

delegate - the delegate converter for outbound and non-interfaces.

JacksonProjectingMessageConverter

public JacksonProjectingMessageConverter(tools.jackson.databind.json.JsonMapper mapper,
 MessagingMessageConverter delegate)

Create a new JacksonProjectingMessageConverter using the given JsonMapper.

Parameters:

mapper - must not be null.

delegate - the delegate converter for outbound and non-interfaces.

Method Details

convertPayload

protected @Nullable Object convertPayload(Message<?> message)

Description copied from class: MessagingMessageConverter

Subclasses can convert the payload; by default, it's sent unchanged to Kafka.

Overrides:

convertPayload in class MessagingMessageConverter

Parameters:

message - the message.

Returns:

the payload.

extractAndConvertValue

protected Object extractAndConvertValue(org.apache.kafka.clients.consumer.ConsumerRecord<?,?> record,
 @Nullable Type type)

Description copied from class: MessagingMessageConverter

Subclasses can convert the value; by default, it's returned as provided by Kafka unless there is a SmartMessageConverter that can convert it.

Overrides:

extractAndConvertValue in class MessagingMessageConverter

Parameters:

record - the record.

type - the required type.

Returns:

the value.