public static interface CodecConfigurer.CustomCodecs
Modifier and Type | Method and Description |
---|---|
void |
decoder(org.springframework.core.codec.Decoder<?> decoder)
Deprecated.
as of 5.1.13, use
register(Object) or
registerWithDefaultConfig(Object) instead. |
void |
encoder(org.springframework.core.codec.Encoder<?> encoder)
Deprecated.
as of 5.1.13, use
register(Object) or
registerWithDefaultConfig(Object) instead. |
void |
reader(HttpMessageReader<?> reader)
Deprecated.
as of 5.1.13, use
register(Object) or
registerWithDefaultConfig(Object) instead. |
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. |
void |
withDefaultCodecConfig(Consumer<CodecConfigurer.DefaultCodecConfig> codecsConfigConsumer)
Deprecated.
as of 5.1.13, use
registerWithDefaultConfig(Object)
or registerWithDefaultConfig(Object, Consumer) instead. |
void |
writer(HttpMessageWriter<?> writer)
Deprecated.
as of 5.1.13, use
register(Object) or
registerWithDefaultConfig(Object) instead. |
void register(Object codec)
HttpMessageReader
HttpMessageWriter
Encoder
(wrapped internally with EncoderHttpMessageWriter
)
Decoder
(wrapped internally with DecoderHttpMessageReader
)
codec
- the codec to registervoid registerWithDefaultConfig(Object codec)
register(Object)
that also applies the below
properties, if configured, via CodecConfigurer.defaultCodecs()
:
The properties are applied every time CodecConfigurer.getReaders()
or
CodecConfigurer.getWriters()
are used to obtain the list of configured
readers or writers.
codec
- the codec to register and apply default config tovoid registerWithDefaultConfig(Object codec, Consumer<CodecConfigurer.DefaultCodecConfig> configConsumer)
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.
codec
- the codec to registerconfigConsumer
- consumer of the default config@Deprecated void decoder(org.springframework.core.codec.Decoder<?> decoder)
register(Object)
or
registerWithDefaultConfig(Object)
instead.Decoder
internally wrapped with
DecoderHttpMessageReader
).decoder
- the decoder to add@Deprecated void encoder(org.springframework.core.codec.Encoder<?> encoder)
register(Object)
or
registerWithDefaultConfig(Object)
instead.Encoder
, internally wrapped with
EncoderHttpMessageWriter
.encoder
- the encoder to add@Deprecated void reader(HttpMessageReader<?> reader)
register(Object)
or
registerWithDefaultConfig(Object)
instead.HttpMessageReader
. For readers of type
DecoderHttpMessageReader
consider using the shortcut
decoder(Decoder)
instead.reader
- the reader to add@Deprecated void writer(HttpMessageWriter<?> writer)
register(Object)
or
registerWithDefaultConfig(Object)
instead.HttpMessageWriter
. For writers of type
EncoderHttpMessageWriter
consider using the shortcut
encoder(Encoder)
instead.writer
- the writer to add@Deprecated void withDefaultCodecConfig(Consumer<CodecConfigurer.DefaultCodecConfig> codecsConfigConsumer)
registerWithDefaultConfig(Object)
or registerWithDefaultConfig(Object, Consumer)
instead.configuration
applied to default codecs. This allows custom codecs to follow general
guidelines applied to default ones, such as logging details and limiting
the amount of buffered data.codecsConfigConsumer
- the default codecs configuration callback