程序包 cn.taketoday.http.codec

接口 CodecConfigurer.CustomCodecs

所有已知实现类:

BaseCodecConfigurer.DefaultCustomCodecs

封闭接口:

CodecConfigurer

public static interface CodecConfigurer.CustomCodecs

Registry for custom HTTP message readers and writers.

方法概要

修饰符和类型	方法	说明
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)	Register a callback for the configuration applied to default codecs.

方法详细资料

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)

参数:

codec - the codec to register

从以下版本开始:

4.0

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.

参数:

codec - the codec to register and apply default config to

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.

参数:

codec - the codec to register

configConsumer - consumer of the default config

withDefaultCodecConfig

void withDefaultCodecConfig(Consumer<CodecConfigurer.DefaultCodecConfig> codecsConfigConsumer)

Register a callback for the 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