java.lang.Object

org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer

All Implemented Interfaces:: RedisJsonSerializer, RedisSerializer<Object>

@Deprecated(since="4.0", forRemoval=true) public class GenericJackson2JsonRedisSerializer extends Object implements RedisJsonSerializer

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0 in favor of GenericJacksonJsonRedisSerializer

Generic Jackson 2-based RedisSerializer that maps objects to and from JSON using dynamic typing.

JSON reading and writing can be customized by configuring a Jackson2ObjectReader and Jackson2ObjectWriter.

Since:

1.6

Author:

Christoph Strobl, Mark Paluch, Mao Shuai, John Blum, Anne Lee

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

GenericJackson2JsonRedisSerializer.GenericJackson2JsonRedisSerializerBuilder

Deprecated, for removal: This API element is subject to removal in a future version.

Builder for configuring and creating a GenericJackson2JsonRedisSerializer.
Constructor Summary

Constructors

Constructor

Description

GenericJackson2JsonRedisSerializer()

Deprecated, for removal: This API element is subject to removal in a future version.

Creates GenericJackson2JsonRedisSerializer initialized with an ObjectMapper configured for default typing.

GenericJackson2JsonRedisSerializer(ObjectMapper mapper)

Deprecated, for removal: This API element is subject to removal in a future version.

Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process.

GenericJackson2JsonRedisSerializer(ObjectMapper mapper, Jackson2ObjectReader reader, Jackson2ObjectWriter writer)

Deprecated, for removal: This API element is subject to removal in a future version.

Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process.

GenericJackson2JsonRedisSerializer(@Nullable String typeHintPropertyName)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates GenericJackson2JsonRedisSerializer initialized with an ObjectMapper configured for default typing using the given name.

GenericJackson2JsonRedisSerializer(@Nullable String typeHintPropertyName, Jackson2ObjectReader reader, Jackson2ObjectWriter writer)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates GenericJackson2JsonRedisSerializer initialized with an ObjectMapper configured for default typing using the given name along with the given, required Jackson2ObjectReader and Jackson2ObjectWriter used to read/write Objects de/serialized as JSON.
Method Summary

Modifier and Type

Method

Description

static GenericJackson2JsonRedisSerializer.GenericJackson2JsonRedisSerializerBuilder

builder()

Deprecated, for removal: This API element is subject to removal in a future version.

Factory method returning a Builder used to construct and configure a GenericJackson2JsonRedisSerializer.

GenericJackson2JsonRedisSerializer

configure(Consumer<ObjectMapper> objectMapperConfigurer)

Deprecated, for removal: This API element is subject to removal in a future version.

Builder method used to configure and customize the internal Jackson ObjectMapper created by this GenericJackson2JsonRedisSerializer and used to de/serialize objects as JSON.

@Nullable Object

deserialize(byte[] source, ResolvableType type)

Deprecated, for removal: This API element is subject to removal in a future version.

Deserialize the given source into an instance of the type described by ResolvableType.

@Nullable Object

deserialize(byte @Nullable [] source)

Deprecated, for removal: This API element is subject to removal in a future version.

Deserialize an object from the given binary data.

<T> @Nullable T

deserialize(byte @Nullable [] source, Class<T> type)

Deprecated, for removal: This API element is subject to removal in a future version.

Deserialized the array of bytes containing JSON as an Object of the given, required type.

protected ObjectMapper

getObjectMapper()

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the configured ObjectMapper used internally by this GenericJackson2JsonRedisSerializer to de/serialize objects as JSON.

static void

registerNullValueSerializer(ObjectMapper objectMapper, @Nullable String typeHintPropertyName)

Deprecated, for removal: This API element is subject to removal in a future version.

Register GenericJackson2JsonRedisSerializer.NullValueSerializer in the given ObjectMapper with an optional typeHintPropertyName.

protected JavaType

resolveType(byte[] source, Class<?> type)

Deprecated, for removal: This API element is subject to removal in a future version.

byte[]

serialize(@Nullable Object value)

Deprecated, for removal: This API element is subject to removal in a future version.

Serialize the given object to binary data.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface RedisJsonSerializer
deserialize

Methods inherited from interface RedisSerializer
canSerialize, getTargetType

Constructor Details
- GenericJackson2JsonRedisSerializer
  
  public GenericJackson2JsonRedisSerializer()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Creates GenericJackson2JsonRedisSerializer initialized with an ObjectMapper configured for default typing.
- GenericJackson2JsonRedisSerializer
  public GenericJackson2JsonRedisSerializer(@Nullable String typeHintPropertyName)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Creates GenericJackson2JsonRedisSerializer initialized with an ObjectMapper configured for default typing using the given name.
  In case name is empty or null, then JsonTypeInfo.Id.CLASS will be used.
  
  Parameters:
  
  typeHintPropertyName - name of the JSON property holding type information; can be null.
  
  See Also:
  
  ObjectMapper.activateDefaultTypingAsProperty(PolymorphicTypeValidator, DefaultTyping, String)
  
  ObjectMapper.activateDefaultTyping(PolymorphicTypeValidator, DefaultTyping, As)
- GenericJackson2JsonRedisSerializer
  public GenericJackson2JsonRedisSerializer(@Nullable String typeHintPropertyName, Jackson2ObjectReader reader, Jackson2ObjectWriter writer)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Creates GenericJackson2JsonRedisSerializer initialized with an ObjectMapper configured for default typing using the given name along with the given, required Jackson2ObjectReader and Jackson2ObjectWriter used to read/write Objects de/serialized as JSON.
  In case name is empty or null, then JsonTypeInfo.Id.CLASS will be used.
  
  Parameters:
  
  typeHintPropertyName - name of the JSON property holding type information; can be null.
  
  reader - Jackson2ObjectReader function to read objects using ObjectMapper.
  
  writer - Jackson2ObjectWriter function to write objects using ObjectMapper.
  
  Since:
  
  3.0
  
  See Also:
  
  ObjectMapper.activateDefaultTypingAsProperty(PolymorphicTypeValidator, DefaultTyping, String)
  
  ObjectMapper.activateDefaultTyping(PolymorphicTypeValidator, DefaultTyping, As)
- GenericJackson2JsonRedisSerializer
  
  public GenericJackson2JsonRedisSerializer(ObjectMapper mapper)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process. For example, an extended SerializerFactory can be configured that provides custom serializers for specific types.
  
  Parameters:
  
  mapper - must not be null.
- GenericJackson2JsonRedisSerializer
  
  public GenericJackson2JsonRedisSerializer(ObjectMapper mapper, Jackson2ObjectReader reader, Jackson2ObjectWriter writer)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process. For example, an extended SerializerFactory can be configured that provides custom serializers for specific types.
  
  Parameters:
  
  mapper - must not be null.
  
  reader - the Jackson2ObjectReader function to read objects using ObjectMapper.
  
  writer - the Jackson2ObjectWriter function to write objects using ObjectMapper.
  
  Since:
  
  3.0
Method Details
- builder
  
  public static GenericJackson2JsonRedisSerializer.GenericJackson2JsonRedisSerializerBuilder builder()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Factory method returning a Builder used to construct and configure a GenericJackson2JsonRedisSerializer.
  
  Returns:
  
  new GenericJackson2JsonRedisSerializer.GenericJackson2JsonRedisSerializerBuilder.
  
  Since:
  
  3.3.1
- registerNullValueSerializer
  
  public static void registerNullValueSerializer(ObjectMapper objectMapper, @Nullable String typeHintPropertyName)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Register GenericJackson2JsonRedisSerializer.NullValueSerializer in the given ObjectMapper with an optional typeHintPropertyName. This method should be called by code that customizes GenericJackson2JsonRedisSerializer by providing an external ObjectMapper.
  
  Parameters:
  
  objectMapper - the object mapper to customize.
  
  typeHintPropertyName - name of the type property. Defaults to @class if null/empty.
  
  Since:
  
  2.2
- getObjectMapper
  
  protected ObjectMapper getObjectMapper()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Gets the configured ObjectMapper used internally by this GenericJackson2JsonRedisSerializer to de/serialize objects as JSON.
  
  Returns:
  
  the configured ObjectMapper.
- serialize
  
  public byte[] serialize(@Nullable Object value) throws SerializationException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: RedisSerializer
  
  Serialize the given object to binary data.
  
  Specified by:
  
  serialize in interface RedisSerializer<Object>
  
  Parameters:
  
  value - object to serialize. Can be null.
  
  Returns:
  
  the equivalent binary data. Can be an empty array but never null.
  
  Throws:
  
  SerializationException
- deserialize
  
  public @Nullable Object deserialize(byte @Nullable [] source) throws SerializationException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: RedisSerializer
  
  Deserialize an object from the given binary data.
  
  Specified by:
  
  deserialize in interface RedisSerializer<Object>
  
  Parameters:
  
  source - object binary representation. Can be null.
  
  Returns:
  
  the equivalent object instance. Can be null.
  
  Throws:
  
  SerializationException
- deserialize
  
  public <T> @Nullable T deserialize(byte @Nullable [] source, Class<T> type) throws SerializationException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Deserialized the array of bytes containing JSON as an Object of the given, required type.
  
  Specified by:
  
  deserialize in interface RedisSerializer<Object>
  
  Parameters:
  
  source - array of bytes containing the JSON to deserialize; can be null.
  
  type - type of Object from which the JSON will be deserialized; must not be null.
  
  Returns:
  
  null for an empty source, or an Object of the given type deserialized from the array of bytes containing JSON.
  
  Throws:
  
  IllegalArgumentException - if the given type is null.
  
  SerializationException - if the array of bytes cannot be deserialized as an instance of the given type
- configure
  
  public GenericJackson2JsonRedisSerializer configure(Consumer<ObjectMapper> objectMapperConfigurer)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Builder method used to configure and customize the internal Jackson ObjectMapper created by this GenericJackson2JsonRedisSerializer and used to de/serialize objects as JSON.
  
  Parameters:
  
  objectMapperConfigurer - Consumer used to configure and customize the internal ObjectMapper; must not be null.
  
  Returns:
  
  this GenericJackson2JsonRedisSerializer.
  
  Throws:
  
  IllegalArgumentException - if the Consumer used to configure and customize the internal ObjectMapper is null.
  
  Since:
  
  3.1.5
- resolveType
  
  protected JavaType resolveType(byte[] source, Class<?> type) throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Throws:
  
  IOException
- deserialize
  
  public @Nullable Object deserialize(byte[] source, ResolvableType type) throws SerializationException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: RedisJsonSerializer
  
  Deserialize the given source into an instance of the type described by ResolvableType. Use this variant for generic types such as List<Person> that cannot be expressed as a Class.
  
  Specified by:
  
  deserialize in interface RedisJsonSerializer
  
  Parameters:
  
  source - the JSON representation to read.
  
  type - reference describing the target type.
  
  Returns:
  
  the deserialized object, or null if source is empty or represents JSON null.
  
  Throws:
  
  SerializationException - if the JSON cannot be deserialized.

Class GenericJackson2JsonRedisSerializer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface RedisJsonSerializer

Methods inherited from interface RedisSerializer

Constructor Details

GenericJackson2JsonRedisSerializer

GenericJackson2JsonRedisSerializer

GenericJackson2JsonRedisSerializer

GenericJackson2JsonRedisSerializer

GenericJackson2JsonRedisSerializer

Method Details

builder

registerNullValueSerializer

getObjectMapper

serialize

deserialize

deserialize

configure

resolveType

deserialize