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:
Closeable,AutoCloseable,org.apache.kafka.common.serialization.Deserializer<T>
@Deprecated(forRemoval=true,
since="4.0")
public class JsonDeserializer<T>
extends Object
implements org.apache.kafka.common.serialization.Deserializer<T>
Deprecated, for removal: This API element is subject to removal in a future version.
Generic
Deserializer for
receiving JSON from Kafka and return Java objects.
IMPORTANT: Configuration must be done completely with property setters or via
configure(Map, boolean), not a mixture. If any setters have been called,
configure(Map, boolean) will be a no-op.
- Author:
- Igor Stepanov, Artem Bilan, Gary Russell, Yanming Zhou, Elliot Kennedy, Torsten Schleede, Ivan Ponomarev, Omer Celik
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated, for removal: This API element is subject to removal in a future version.Kafka config property for the default key type if no header.static final StringDeprecated, for removal: This API element is subject to removal in a future version.A method name to determine theJavaTypeto deserialize the key to: 'com.Foo.deserialize'.protected final com.fasterxml.jackson.databind.ObjectMapperDeprecated, for removal: This API element is subject to removal in a future version.static final StringDeprecated, for removal: This API element is subject to removal in a future version.Kafka config property for removing type headers (default true).protected @Nullable com.fasterxml.jackson.databind.JavaTypeDeprecated, for removal: This API element is subject to removal in a future version.static final StringDeprecated, for removal: This API element is subject to removal in a future version.Kafka config property for trusted deserialization packages.static final StringDeprecated, for removal: This API element is subject to removal in a future version.Kafka config property to add type mappings to the type mapper: 'foo=com.Foo,bar=com.Bar'.protected Jackson2JavaTypeMapperDeprecated, for removal: This API element is subject to removal in a future version.static final StringDeprecated, for removal: This API element is subject to removal in a future version.Kafka config property for using type headers (default true).static final StringDeprecated, for removal: This API element is subject to removal in a future version.Kafka config property for the default value type if no header.static final StringDeprecated, for removal: This API element is subject to removal in a future version.A method name to determine theJavaTypeto deserialize the value to: 'com.Foo.deserialize'. -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version.Construct an instance with a defaultObjectMapper.JsonDeserializer(@Nullable com.fasterxml.jackson.core.type.TypeReference<? super T> targetType) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and a defaultObjectMapper.JsonDeserializer(@Nullable com.fasterxml.jackson.core.type.TypeReference<? super T> targetType, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and useHeadersIfPresent with a defaultObjectMapper.JsonDeserializer(@Nullable com.fasterxml.jackson.core.type.TypeReference<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type,ObjectMapperand useHeadersIfPresent.JsonDeserializer(com.fasterxml.jackson.core.type.TypeReference<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, andObjectMapper.JsonDeserializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and a defaultObjectMapper.JsonDeserializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and useHeadersIfPresent with a defaultObjectMapper.JsonDeserializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, andObjectMapper.JsonDeserializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type,ObjectMapperand useHeadersIfPresent.JsonDeserializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the providedObjectMapper.JsonDeserializer(@Nullable Class<? super T> targetType) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and a defaultObjectMapper.JsonDeserializer(@Nullable Class<? super T> targetType, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and useHeadersIfPresent with a defaultObjectMapper.JsonDeserializer(@Nullable Class<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type,ObjectMapperand useHeadersIfPresent.JsonDeserializer(Class<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, andObjectMapper. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddTrustedPackages(String... packages) Deprecated, for removal: This API element is subject to removal in a future version.Add trusted packages for deserialization.voidclose()Deprecated, for removal: This API element is subject to removal in a future version.voidDeprecated, for removal: This API element is subject to removal in a future version.<X> JsonDeserializer<X> copyWithType(com.fasterxml.jackson.core.type.TypeReference<? super X> newTargetType) Deprecated, for removal: This API element is subject to removal in a future version.Copies this deserializer with same configuration, except new target type reference is used.<X> JsonDeserializer<X> copyWithType(com.fasterxml.jackson.databind.JavaType newTargetType) Deprecated, for removal: This API element is subject to removal in a future version.Copies this deserializer with same configuration, except new target java type is used.<X> JsonDeserializer<X> copyWithType(Class<? super X> newTargetType) Deprecated, for removal: This API element is subject to removal in a future version.Copies this deserializer with same configuration, except new target type is used.@Nullable Tdeserialize(String topic, byte[] data) Deprecated, for removal: This API element is subject to removal in a future version.@Nullable Tdeserialize(String topic, org.apache.kafka.common.header.Headers headers, byte[] data) Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Don't remove type information headers.forKeys()Deprecated, for removal: This API element is subject to removal in a future version.Designate this deserializer for deserializing keys (default is values); only applies if the default type mapper is used.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Ignore type information headers and use the configured target class.voidsetRemoveTypeHeaders(boolean removeTypeHeaders) Deprecated, for removal: This API element is subject to removal in a future version.Set to false to retain type information headers after deserialization.voidsetTypeFunction(BiFunction<byte[], org.apache.kafka.common.header.Headers, com.fasterxml.jackson.databind.JavaType> typeFunction) Deprecated, for removal: This API element is subject to removal in a future version.Set aBiFunctionthat receives the data to be deserialized and the headers and returns a JavaType.voidsetTypeMapper(Jackson2JavaTypeMapper typeMapper) Deprecated, for removal: This API element is subject to removal in a future version.Set a customized type mapper.voidsetTypeResolver(JsonTypeResolver typeResolver) Deprecated, for removal: This API element is subject to removal in a future version.Set aJsonTypeResolverthat receives the data to be deserialized and the headers and returns a JavaType.voidsetUseTypeHeaders(boolean useTypeHeaders) Deprecated, for removal: This API element is subject to removal in a future version.Set to false to ignore type information in headers and use the configured target type instead.voidsetUseTypeMapperForKey(boolean isKey) Deprecated, for removal: This API element is subject to removal in a future version.Configure the default Jackson2JavaTypeMapper to use key type headers.trustedPackages(String... packages) Deprecated, for removal: This API element is subject to removal in a future version.Add trusted packages to the default type mapper.typeFunction(BiFunction<byte[], org.apache.kafka.common.header.Headers, com.fasterxml.jackson.databind.JavaType> typeFunction) Deprecated, for removal: This API element is subject to removal in a future version.Set aBiFunctionthat receives the data to be deserialized and the headers and returns a JavaType.typeMapper(Jackson2JavaTypeMapper mapper) Deprecated, for removal: This API element is subject to removal in a future version.Use the suppliedJackson2JavaTypeMapper.typeResolver(JsonTypeResolver resolver) Deprecated, for removal: This API element is subject to removal in a future version.Set aJsonTypeResolverthat receives the data to be deserialized and the headers and returns a JavaType.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.kafka.common.serialization.Deserializer
deserialize
-
Field Details
-
KEY_DEFAULT_TYPE
Deprecated, for removal: This API element is subject to removal in a future version.Kafka config property for the default key type if no header.- See Also:
-
VALUE_DEFAULT_TYPE
Deprecated, for removal: This API element is subject to removal in a future version.Kafka config property for the default value type if no header.- See Also:
-
TRUSTED_PACKAGES
Deprecated, for removal: This API element is subject to removal in a future version.Kafka config property for trusted deserialization packages.- See Also:
-
TYPE_MAPPINGS
Deprecated, for removal: This API element is subject to removal in a future version.Kafka config property to add type mappings to the type mapper: 'foo=com.Foo,bar=com.Bar'.- See Also:
-
REMOVE_TYPE_INFO_HEADERS
Deprecated, for removal: This API element is subject to removal in a future version.Kafka config property for removing type headers (default true).- See Also:
-
USE_TYPE_INFO_HEADERS
Deprecated, for removal: This API element is subject to removal in a future version.Kafka config property for using type headers (default true).- Since:
- 2.2.3
- See Also:
-
KEY_TYPE_METHOD
Deprecated, for removal: This API element is subject to removal in a future version.A method name to determine theJavaTypeto deserialize the key to: 'com.Foo.deserialize'. SeeJsonTypeResolver.resolveType(java.lang.String, byte[], org.apache.kafka.common.header.Headers)for the signature.- See Also:
-
VALUE_TYPE_METHOD
Deprecated, for removal: This API element is subject to removal in a future version.A method name to determine theJavaTypeto deserialize the value to: 'com.Foo.deserialize'. SeeJsonTypeResolver.resolveType(java.lang.String, byte[], org.apache.kafka.common.header.Headers)for the signature.- See Also:
-
objectMapper
protected final com.fasterxml.jackson.databind.ObjectMapper objectMapperDeprecated, for removal: This API element is subject to removal in a future version. -
targetType
protected @Nullable com.fasterxml.jackson.databind.JavaType targetTypeDeprecated, for removal: This API element is subject to removal in a future version. -
typeMapper
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Constructor Details
-
JsonDeserializer
public JsonDeserializer()Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with a defaultObjectMapper. -
JsonDeserializer
public JsonDeserializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the providedObjectMapper.- Parameters:
objectMapper- a custom object mapper.
-
JsonDeserializer
Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and a defaultObjectMapper.- Parameters:
targetType- the target type to use if no type info headers are present.
-
JsonDeserializer
public JsonDeserializer(@Nullable com.fasterxml.jackson.core.type.TypeReference<? super T> targetType) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and a defaultObjectMapper.- Parameters:
targetType- the target type reference to use if no type info headers are present.- Since:
- 2.3
-
JsonDeserializer
public JsonDeserializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and a defaultObjectMapper.- Parameters:
targetType- the target java type to use if no type info headers are present.- Since:
- 2.3
-
JsonDeserializer
Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and useHeadersIfPresent with a defaultObjectMapper.- Parameters:
targetType- the target type.useHeadersIfPresent- true to use headers if present and fall back to target type if not.- Since:
- 2.2
-
JsonDeserializer
public JsonDeserializer(@Nullable com.fasterxml.jackson.core.type.TypeReference<? super T> targetType, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and useHeadersIfPresent with a defaultObjectMapper.- Parameters:
targetType- the target type reference.useHeadersIfPresent- true to use headers if present and fall back to target type if not.- Since:
- 2.3
-
JsonDeserializer
public JsonDeserializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, and useHeadersIfPresent with a defaultObjectMapper.- Parameters:
targetType- the target java type.useHeadersIfPresent- true to use headers if present and fall back to target type if not.- Since:
- 2.3
-
JsonDeserializer
public JsonDeserializer(Class<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, andObjectMapper.- Parameters:
targetType- the target type to use if no type info headers are present.objectMapper- the mapper. type if not.
-
JsonDeserializer
public JsonDeserializer(com.fasterxml.jackson.core.type.TypeReference<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, andObjectMapper.- Parameters:
targetType- the target type reference to use if no type info headers are present.objectMapper- the mapper. type if not.
-
JsonDeserializer
public JsonDeserializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type, andObjectMapper.- Parameters:
targetType- the target java type to use if no type info headers are present.objectMapper- the mapper. type if not.
-
JsonDeserializer
public JsonDeserializer(@Nullable Class<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type,ObjectMapperand useHeadersIfPresent.- Parameters:
targetType- the target type.objectMapper- the mapper.useHeadersIfPresent- true to use headers if present and fall back to target type if not.- Since:
- 2.2
-
JsonDeserializer
public JsonDeserializer(@Nullable com.fasterxml.jackson.core.type.TypeReference<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type,ObjectMapperand useHeadersIfPresent.- Parameters:
targetType- the target type reference.objectMapper- the mapper.useHeadersIfPresent- true to use headers if present and fall back to target type if not.- Since:
- 2.3
-
JsonDeserializer
public JsonDeserializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper, boolean useHeadersIfPresent) Deprecated, for removal: This API element is subject to removal in a future version.Construct an instance with the provided target type,ObjectMapperand useHeadersIfPresent.- Parameters:
targetType- the target type reference.objectMapper- the mapper.useHeadersIfPresent- true to use headers if present and fall back to target type if not.- Since:
- 2.3
-
-
Method Details
-
getTypeMapper
Deprecated, for removal: This API element is subject to removal in a future version. -
setTypeMapper
Deprecated, for removal: This API element is subject to removal in a future version.Set a customized type mapper. If the mapper is anAbstractJavaTypeMapper, any class mappings configured in the mapper will be added to the trusted packages.- Parameters:
typeMapper- the type mapper.- Since:
- 2.1
-
setUseTypeMapperForKey
public void setUseTypeMapperForKey(boolean isKey) Deprecated, for removal: This API element is subject to removal in a future version.Configure the default Jackson2JavaTypeMapper to use key type headers.- Parameters:
isKey- Use key type headers if true- Since:
- 2.1.3
-
setRemoveTypeHeaders
public void setRemoveTypeHeaders(boolean removeTypeHeaders) Deprecated, for removal: This API element is subject to removal in a future version.Set to false to retain type information headers after deserialization. Default true.- Parameters:
removeTypeHeaders- true to remove headers.- Since:
- 2.2
-
setUseTypeHeaders
public void setUseTypeHeaders(boolean useTypeHeaders) Deprecated, for removal: This API element is subject to removal in a future version.Set to false to ignore type information in headers and use the configured target type instead. Only applies if the preconfigured type mapper is used. Default true.- Parameters:
useTypeHeaders- false to ignore type headers.- Since:
- 2.2.8
-
setTypeFunction
public void setTypeFunction(BiFunction<byte[], org.apache.kafka.common.header.Headers, com.fasterxml.jackson.databind.JavaType> typeFunction) Deprecated, for removal: This API element is subject to removal in a future version.Set aBiFunctionthat receives the data to be deserialized and the headers and returns a JavaType.- Parameters:
typeFunction- the function.- Since:
- 2.5
-
setTypeResolver
Deprecated, for removal: This API element is subject to removal in a future version.Set aJsonTypeResolverthat receives the data to be deserialized and the headers and returns a JavaType.- Parameters:
typeResolver- the resolver.- Since:
- 2.5.3
-
configure
-
addTrustedPackages
Deprecated, for removal: This API element is subject to removal in a future version.Add trusted packages for deserialization.- Parameters:
packages- the packages.- Since:
- 2.1
-
deserialize
-
deserialize
-
close
public void close()Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceorg.apache.kafka.common.serialization.Deserializer<T>
-
copyWithType
Deprecated, for removal: This API element is subject to removal in a future version.Copies this deserializer with same configuration, except new target type is used.- Type Parameters:
X- new deserialization result type- Parameters:
newTargetType- type used for when type headers are missing, not null- Returns:
- new instance of deserializer with type changes
- Since:
- 2.6
-
copyWithType
public <X> JsonDeserializer<X> copyWithType(com.fasterxml.jackson.core.type.TypeReference<? super X> newTargetType) Deprecated, for removal: This API element is subject to removal in a future version.Copies this deserializer with same configuration, except new target type reference is used.- Type Parameters:
X- new deserialization result type- Parameters:
newTargetType- type reference used for when type headers are missing, not null- Returns:
- new instance of deserializer with type changes
- Since:
- 2.6
-
copyWithType
Deprecated, for removal: This API element is subject to removal in a future version.Copies this deserializer with same configuration, except new target java type is used.- Type Parameters:
X- new deserialization result type- Parameters:
newTargetType- java type used for when type headers are missing, not null- Returns:
- new instance of deserializer with type changes
- Since:
- 2.6
-
forKeys
Deprecated, for removal: This API element is subject to removal in a future version.Designate this deserializer for deserializing keys (default is values); only applies if the default type mapper is used.- Returns:
- the deserializer.
- Since:
- 2.3
-
dontRemoveTypeHeaders
Deprecated, for removal: This API element is subject to removal in a future version.Don't remove type information headers.- Returns:
- the deserializer.
- Since:
- 2.3
- See Also:
-
ignoreTypeHeaders
Deprecated, for removal: This API element is subject to removal in a future version.Ignore type information headers and use the configured target class.- Returns:
- the deserializer.
- Since:
- 2.3
- See Also:
-
typeMapper
Deprecated, for removal: This API element is subject to removal in a future version.Use the suppliedJackson2JavaTypeMapper.- Parameters:
mapper- the mapper.- Returns:
- the deserializer.
- Since:
- 2.3
- See Also:
-
trustedPackages
Deprecated, for removal: This API element is subject to removal in a future version.Add trusted packages to the default type mapper.- Parameters:
packages- the packages.- Returns:
- the deserializer.
- Since:
- 2, 5
-
typeFunction
public JsonDeserializer<T> typeFunction(BiFunction<byte[], org.apache.kafka.common.header.Headers, com.fasterxml.jackson.databind.JavaType> typeFunction) Deprecated, for removal: This API element is subject to removal in a future version.Set aBiFunctionthat receives the data to be deserialized and the headers and returns a JavaType.- Parameters:
typeFunction- the function.- Returns:
- the deserializer.
- Since:
- 2.5
-
typeResolver
Deprecated, for removal: This API element is subject to removal in a future version.Set aJsonTypeResolverthat receives the data to be deserialized and the headers and returns a JavaType.- Parameters:
resolver- the resolver.- Returns:
- the deserializer.
- Since:
- 2.5.3
-
JacksonJsonDeserializerfor Jackson 3.