Package org.springframework.data.redis.serializer

Class GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B extends tools.jackson.databind.cfg.MapperBuilder<? extends tools.jackson.databind.ObjectMapper,? extends tools.jackson.databind.cfg.MapperBuilder<?,?>>>

java.lang.Object

org.springframework.data.redis.serializer.GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>

Type Parameters:

B - type of the MapperBuilder.

Enclosing class:

GenericJacksonJsonRedisSerializer

public static class GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B extends tools.jackson.databind.cfg.MapperBuilder<? extends tools.jackson.databind.ObjectMapper,? extends tools.jackson.databind.cfg.MapperBuilder<?,?>>>
extends Object

GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder wraps around a JsonMapper.Builder providing dedicated methods to configure aspects like NullValue serialization strategy for the resulting ObjectMapper to be used with GenericJacksonJsonRedisSerializer as well as potential Object/-reader and -writer settings.

Method Summary

Modifier and Type	Method	Description
GenericJacksonJsonRedisSerializer	build()	Build a new GenericJacksonJsonRedisSerializer instance using the configured settings.
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	customize(Consumer<B> mapperBuilderCustomizer)	Provide a customizer to configure the ObjectMapper through its MapperBuilder.
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	enableDefaultTyping(tools.jackson.databind.jsontype.PolymorphicTypeValidator typeValidator)	Enables default typing using the given PolymorphicTypeValidator.
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	enableSpringCacheNullValueSupport()	Registers a StdSerializer capable of serializing Spring Cache NullValue using the mappers default type property.
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	enableSpringCacheNullValueSupport(String typePropertyName)	Registers a StdSerializer capable of serializing Spring Cache NullValue using the given type property name.
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	enableUnsafeDefaultTyping()	Enables default typing without any type validation constraints.
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	reader(JacksonObjectReader reader)	Configures the JacksonObjectReader.
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	typePropertyName(String typePropertyName)	Configure the type property name used for default typing and enableSpringCacheNullValueSupport().
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	typeValidator(tools.jackson.databind.jsontype.PolymorphicTypeValidator typeValidator)	Provide a PolymorphicTypeValidator to validate polymorphic types during deserialization.
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	writer(JacksonObjectWriter writer)	Configures the JacksonObjectWriter.

Methods inherited from class java.lang.Object

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

Method Details

enableSpringCacheNullValueSupport

@Contract("-> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> enableSpringCacheNullValueSupport()

Registers a StdSerializer capable of serializing Spring Cache NullValue using the mappers default type property. Please make sure to active default typing accordingly.

Returns:

this.

enableSpringCacheNullValueSupport

@Contract("_ -> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> enableSpringCacheNullValueSupport(String typePropertyName)

Registers a StdSerializer capable of serializing Spring Cache NullValue using the given type property name. Please make sure to active default typing accordingly.

Returns:

this builder.

enableUnsafeDefaultTyping

@Contract("-> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> enableUnsafeDefaultTyping()

Enables default typing without any type validation constraints.

WARNING: without restrictions of the PolymorphicTypeValidator deserialization is vulnerable to arbitrary code execution when reading from untrusted sources.

Returns:

this builder.

See Also:

• https://owasp.org/www-community/vulnerabilities/Deserialization_of_untrusted_data

enableDefaultTyping

@Contract("_ -> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> enableDefaultTyping(tools.jackson.databind.jsontype.PolymorphicTypeValidator typeValidator)

Enables default typing using the given PolymorphicTypeValidator.

Returns:

this builder.

typeValidator

@Contract("_ -> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> typeValidator(tools.jackson.databind.jsontype.PolymorphicTypeValidator typeValidator)

Provide a PolymorphicTypeValidator to validate polymorphic types during deserialization.

Parameters:

typeValidator - the validator to use, defaults to a permissive validator that allows all types.

Returns:

this builder.

typePropertyName

@Contract("_ -> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> typePropertyName(String typePropertyName)

Configure the type property name used for default typing and enableSpringCacheNullValueSupport().

Returns:

this builder.

writer

@Contract("_ -> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> writer(JacksonObjectWriter writer)

Configures the JacksonObjectWriter.

Parameters:

writer - must not be null.

Returns:

this builder.

reader

@Contract("_ -> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> reader(JacksonObjectReader reader)

Configures the JacksonObjectReader.

Parameters:

reader - must not be null.

Returns:

this builder.

customize

@Contract("_ -> this")
public GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> customize(Consumer<B> mapperBuilderCustomizer)

Provide a customizer to configure the ObjectMapper through its MapperBuilder.

Parameters:

mapperBuilderCustomizer - the configurer to apply to the ObjectMapper builder.

Returns:

this builder.

build

@Contract("-> new")
public GenericJacksonJsonRedisSerializer build()

Build a new GenericJacksonJsonRedisSerializer instance using the configured settings.

Returns:

a new GenericJacksonJsonRedisSerializer instance.