Package org.springframework.http.codec

Interface CodecConfigurer.CustomCodecs

Enclosing interface:

CodecConfigurer

public static interface CodecConfigurer.CustomCodecs

Registry for custom HTTP message readers and writers.

Method Summary

Modifier and Type	Method	Description
void	register(Object codec)	Register a custom codec.
void	registerWithDefaultConfig(Object codec)	Variant of register(Object) that also applies the below properties, if configured, via CodecConfigurer.defaultCodecs(): maxInMemorySize enableLoggingRequestDetails
void	registerWithDefaultConfig(Object codec, Consumer<CodecConfigurer.DefaultCodecConfig> configConsumer)	Variant of register(Object) that also allows the caller to apply the properties from CodecConfigurer.DefaultCodecConfig to the given codec.

Method Details

register

void register(Object codec)

Register a custom codec. This is expected to be one of the following:

• HttpMessageReader
• HttpMessageWriter
• Encoder (wrapped internally with EncoderHttpMessageWriter)
• Decoder (wrapped internally with DecoderHttpMessageReader)

Parameters:

codec - the codec to register

Since:

5.1.13

registerWithDefaultConfig

void registerWithDefaultConfig(Object codec)

Variant of register(Object) that also applies the below properties, if configured, via CodecConfigurer.defaultCodecs():

• maxInMemorySize
• enableLoggingRequestDetails

The properties are applied every time CodecConfigurer.getReaders() or CodecConfigurer.getWriters() are used to obtain the list of configured readers or writers.

Parameters:

codec - the codec to register and apply default config to

Since:

5.1.13

registerWithDefaultConfig

void registerWithDefaultConfig(Object codec,
 Consumer<CodecConfigurer.DefaultCodecConfig> configConsumer)

Variant of register(Object) that also allows the caller to apply the properties from CodecConfigurer.DefaultCodecConfig to the given codec. If you want to apply all the properties, prefer using registerWithDefaultConfig(Object).

The consumer is called every time CodecConfigurer.getReaders() or CodecConfigurer.getWriters() are used to obtain the list of configured readers or writers.

Parameters:

codec - the codec to register

configConsumer - consumer of the default config

Since:

5.1.13