Interface RedisMessageConverters

public interface RedisMessageConverters

Converter configuration that provides a RedisMessageConverters.Builder to create a composite MessageConverter for Redis listener endpoints.

By default, it registers a StringMessageConverter, a ByteArrayMessageConverter, and JSON converters if a supported library (Jackson, Gson, JSON-B, or Kotlin Serialization) is present on the classpath.

Converters are provided with DefaultContentTypeResolver support, and the default content type can be configured via RedisMessageConverters.Builder.defaultMimeType(MimeType).

Note:RedisMessageConverters uses Spring Data Redis's RedisSerializers for JSON serialization. Its JSON serialization format and behavior might slightly differ from Spring Messaging's JacksonJsonMessageConverter. If you wish to use Spring Messaging's variant then configure the desired converter through RedisMessageConverters.Builder.addCustomConverter(MessageConverter).

Since:

4.1

Author:

Ilyass Bougati, Mark Paluch

See Also:

• GenericJacksonJsonRedisSerializer
• GenericJackson2JsonRedisSerializer
• StringMessageConverter
• JsonbMessageConverter
• GsonMessageConverter
• KotlinSerializationJsonMessageConverter
• ByteArrayMessageConverter
• SerializerMessageConverter
• JdkSerializerMessageConverter

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RedisMessageConverters.Builder	A builder for configuring a MessageConverter.

Method Summary

Modifier and Type	Method	Description
static RedisMessageConverters.Builder	builder()	Create a new RedisMessageConverters.Builder instance.
static MessageConverter	createMessageConverter()	Create a new MessageConverter with a default configuration.
static MessageConverter	createMessageConverter(Consumer<RedisMessageConverters.Builder> builderConsumer)	Create a new MessageConverter by applying the given builder consumer a RedisMessageConverters.Builder instance.
MessageConverter	getConverter()	Return the configured MessageConverter.

Method Details

getConverter

MessageConverter getConverter()

Return the configured MessageConverter.

builder

static RedisMessageConverters.Builder builder()

Create a new RedisMessageConverters.Builder instance.

Returns:

a new RedisMessageConverters.Builder

createMessageConverter

static MessageConverter createMessageConverter()

Create a new MessageConverter with a default configuration. This is equivalent to builder().build().getConverter() and uses class path scanning to determine available MessageConverters such as Jackson, Gson, JSON-B, or Kotlin Serialization.

Returns:

the configured MessageConverter.

createMessageConverter

static MessageConverter createMessageConverter(Consumer<RedisMessageConverters.Builder> builderConsumer)

Create a new MessageConverter by applying the given builder consumer a RedisMessageConverters.Builder instance. The MessageConverter is then built and returned.

Returns:

the configured MessageConverter.