org.springframework.kafka.support.serializer

Class JsonDeserializer<T>

java.lang.Object

org.springframework.kafka.support.serializer.JsonDeserializer<T>

Type Parameters:

T - class of the entity, representing messages

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.kafka.common.serialization.Deserializer<T>, org.apache.kafka.common.serialization.ExtendedDeserializer<T>

public class JsonDeserializer<T>
extends java.lang.Object
implements org.apache.kafka.common.serialization.ExtendedDeserializer<T>

Generic Deserializer for receiving JSON from Kafka and return Java objects.

Author:

Igor Stepanov, Artem Bilan, Gary Russell, Yanming Zhou

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kafka.common.serialization.ExtendedDeserializer

org.apache.kafka.common.serialization.ExtendedDeserializer.Wrapper<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_KEY_TYPE Kafka config property for the default key type if no header.
static java.lang.String	DEFAULT_VALUE_TYPE Kafka config property for the default value type if no header.
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected java.lang.Class<T>	targetType
static java.lang.String	TRUSTED_PACKAGES Kafka config property for trusted deserialization packages.
protected Jackson2JavaTypeMapper	typeMapper

Constructor Summary

Constructors

Modifier	Constructor and Description
	JsonDeserializer()
	JsonDeserializer(java.lang.Class<T> targetType)
	JsonDeserializer(java.lang.Class<T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
protected	JsonDeserializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
void	addTrustedPackages(java.lang.String... packages) Add trusted packages for deserialization.
void	close()
void	configure(java.util.Map<java.lang.String,?> configs, boolean isKey)
T	deserialize(java.lang.String topic, byte[] data)
T	deserialize(java.lang.String topic, org.apache.kafka.common.header.Headers headers, byte[] data)
Jackson2JavaTypeMapper	getTypeMapper()
void	setTypeMapper(Jackson2JavaTypeMapper typeMapper) Set a customized type mapper.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEY_TYPE

public static final java.lang.String DEFAULT_KEY_TYPE

Kafka config property for the default key type if no header.

See Also:

Constant Field Values

DEFAULT_VALUE_TYPE

public static final java.lang.String DEFAULT_VALUE_TYPE

Kafka config property for the default value type if no header.

See Also:

Constant Field Values

TRUSTED_PACKAGES

public static final java.lang.String TRUSTED_PACKAGES

Kafka config property for trusted deserialization packages.

See Also:

Constant Field Values

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

targetType

protected java.lang.Class<T> targetType

typeMapper

protected Jackson2JavaTypeMapper typeMapper

Constructor Detail

JsonDeserializer

public JsonDeserializer()

JsonDeserializer

protected JsonDeserializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

JsonDeserializer

public JsonDeserializer(java.lang.Class<T> targetType)

JsonDeserializer

public JsonDeserializer(java.lang.Class<T> targetType,
                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

getTypeMapper

public Jackson2JavaTypeMapper getTypeMapper()

setTypeMapper

public void setTypeMapper(Jackson2JavaTypeMapper typeMapper)

Set a customized type mapper.

Parameters:

typeMapper - the type mapper.

Since:

2.1

configure

public void configure(java.util.Map<java.lang.String,?> configs,
                      boolean isKey)

Specified by:

configure in interface org.apache.kafka.common.serialization.Deserializer<T>

addTrustedPackages

public void addTrustedPackages(java.lang.String... packages)

Add trusted packages for deserialization.

Parameters:

packages - the packages.

Since:

2.1

deserialize

public T deserialize(java.lang.String topic,
                     org.apache.kafka.common.header.Headers headers,
                     byte[] data)

Specified by:

deserialize in interface org.apache.kafka.common.serialization.ExtendedDeserializer<T>

deserialize

public T deserialize(java.lang.String topic,
                     byte[] data)

Specified by:

deserialize in interface org.apache.kafka.common.serialization.Deserializer<T>

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface org.apache.kafka.common.serialization.Deserializer<T>