Package org.springframework.kafka.support.mapping

Class DefaultJackson2JavaTypeMapper

java.lang.Object

org.springframework.kafka.support.mapping.AbstractJavaTypeMapper

org.springframework.kafka.support.mapping.DefaultJackson2JavaTypeMapper

All Implemented Interfaces:

Aware, BeanClassLoaderAware, ClassMapper, Jackson2JavaTypeMapper

public class DefaultJackson2JavaTypeMapper
extends AbstractJavaTypeMapper
implements Jackson2JavaTypeMapper

Jackson 2 type mapper.

Since:

2.1

Author:

Mark Pollack, Sam Nelson, Andreas Asplund, Artem Bilan, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.kafka.support.mapping.Jackson2JavaTypeMapper

Jackson2JavaTypeMapper.TypePrecedence

Field Summary

Fields inherited from class org.springframework.kafka.support.mapping.AbstractJavaTypeMapper

DEFAULT_CLASSID_FIELD_NAME, DEFAULT_CONTENT_CLASSID_FIELD_NAME, DEFAULT_KEY_CLASSID_FIELD_NAME, KEY_DEFAULT_CLASSID_FIELD_NAME, KEY_DEFAULT_CONTENT_CLASSID_FIELD_NAME, KEY_DEFAULT_KEY_CLASSID_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultJackson2JavaTypeMapper()

Method Summary

Modifier and Type	Method	Description
void	addTrustedPackages(String... packagesToTrust)	Specify a set of packages to trust during deserialization.
void	fromClass(Class<?> clazz, org.apache.kafka.common.header.Headers headers)
void	fromJavaType(com.fasterxml.jackson.databind.JavaType javaType, org.apache.kafka.common.header.Headers headers)
Jackson2JavaTypeMapper.TypePrecedence	getTypePrecedence()	Return the precedence.
void	removeHeaders(org.apache.kafka.common.header.Headers headers)	Remove the type information headers.
void	setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence typePrecedence)	Set the precedence for evaluating type information in message properties.
Class<?>	toClass(org.apache.kafka.common.header.Headers headers)
com.fasterxml.jackson.databind.JavaType	toJavaType(org.apache.kafka.common.header.Headers headers)

Methods inherited from class org.springframework.kafka.support.mapping.AbstractJavaTypeMapper

addHeader, getClassIdFieldName, getClassLoader, getContentClassIdFieldName, getIdClassMapping, getKeyClassIdFieldName, retrieveHeader, retrieveHeaderAsString, setBeanClassLoader, setClassIdFieldName, setContentClassIdFieldName, setIdClassMapping, setKeyClassIdFieldName, setUseForKey

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultJackson2JavaTypeMapper

public DefaultJackson2JavaTypeMapper()

Method Details

getTypePrecedence

public Jackson2JavaTypeMapper.TypePrecedence getTypePrecedence()

Return the precedence.

Specified by:

getTypePrecedence in interface Jackson2JavaTypeMapper

Returns:

the precedence.

See Also:

• setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence)

setTypePrecedence

public void setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence typePrecedence)

Description copied from interface: Jackson2JavaTypeMapper

Set the precedence for evaluating type information in message properties. When using @KafkaListener at the method level, the framework attempts to determine the target type for payload conversion from the method signature. If so, this type is provided by the MessagingMessageListenerAdapter.

By default, if the type is concrete (not abstract, not an interface), this will be used ahead of type information provided in the __TypeId__ and associated headers provided by the sender.

If you wish to force the use of the __TypeId__ and associated headers (such as when the actual type is a subclass of the method argument type), set the precedence to Jackson2JavaTypeMapper.TypePrecedence.TYPE_ID.

Specified by:

setTypePrecedence in interface Jackson2JavaTypeMapper

Parameters:

typePrecedence - the precedence.

addTrustedPackages

public void addTrustedPackages(String... packagesToTrust)

Specify a set of packages to trust during deserialization. The asterisk (*) means trust all.

Specified by:

addTrustedPackages in interface Jackson2JavaTypeMapper

Parameters:

packagesToTrust - the trusted Java packages for deserialization

toJavaType

public com.fasterxml.jackson.databind.JavaType toJavaType(org.apache.kafka.common.header.Headers headers)

Specified by:

toJavaType in interface Jackson2JavaTypeMapper

fromJavaType

public void fromJavaType(com.fasterxml.jackson.databind.JavaType javaType,
 org.apache.kafka.common.header.Headers headers)

Specified by:

fromJavaType in interface Jackson2JavaTypeMapper

fromClass

public void fromClass(Class<?> clazz,
 org.apache.kafka.common.header.Headers headers)

Specified by:

fromClass in interface ClassMapper

toClass

public Class<?> toClass(org.apache.kafka.common.header.Headers headers)

Specified by:

toClass in interface ClassMapper

removeHeaders

public void removeHeaders(org.apache.kafka.common.header.Headers headers)

Description copied from interface: Jackson2JavaTypeMapper

Remove the type information headers.

Specified by:

removeHeaders in interface Jackson2JavaTypeMapper

Parameters:

headers - the headers.