Modifier and Type	Class and Description
protected static class	BaseCodecConfigurer.DefaultCustomCodecs Default implementation of `CustomCodecs`.

Modifier and Type	Field and Description
protected final BaseCodecConfigurer.DefaultCustomCodecs	customCodecs
protected final BaseDefaultCodecs	defaultCodecs

Access	Constructor and Description
pack-priv	BaseCodecConfigurer(BaseDefaultCodecs defaultCodecs) Constructor with the base `BaseDefaultCodecs` to use, which can be a client or server specific variant.
protected	BaseCodecConfigurer(BaseCodecConfigurer other) Create a deep copy of the given `BaseCodecConfigurer`.

Modifier and Type	Method and Description
public abstract CodecConfigurer	clone() Redeclares org.springframework.http.codec.CodecConfigurer.clone. Overrides java.lang.Object.clone. Create a copy of this `CodecConfigurer`.
protected abstract BaseDefaultCodecs	cloneDefaultCodecs() Subclasses should override this to create a deep copy of `BaseDefaultCodecs` which can be client or server specific.
public CodecConfigurer.CustomCodecs	customCodecs() Implements org.springframework.http.codec.CodecConfigurer.customCodecs. Register custom HTTP message readers or writers in addition to the ones registered by default.
public CodecConfigurer.DefaultCodecs	defaultCodecs() Implements org.springframework.http.codec.CodecConfigurer.defaultCodecs. Provides a way to customize or replace HTTP message readers and writers registered by default.
public List<HttpMessageReader<?>>	getReaders() Implements org.springframework.http.codec.CodecConfigurer.getReaders. Obtain the configured HTTP message readers.
public List<HttpMessageWriter<?>>	getWriters() Implements org.springframework.http.codec.CodecConfigurer.getWriters. Obtain the configured HTTP message writers.
public void	registerDefaults(boolean shouldRegister) Implements org.springframework.http.codec.CodecConfigurer.registerDefaults. Provides a way to completely turn off registration of default HTTP message readers and writers, and instead rely only on the ones provided via `customCodecs()`.

customCodecs	back to summary
protected final BaseCodecConfigurer.DefaultCustomCodecs customCodecs

defaultCodecs	back to summary
protected final BaseDefaultCodecs defaultCodecs

BaseCodecConfigurer	back to summary
pack-priv BaseCodecConfigurer(BaseDefaultCodecs defaultCodecs) Constructor with the base `BaseDefaultCodecs` to use, which can be a client or server specific variant.

BaseCodecConfigurer	back to summary
protected BaseCodecConfigurer(BaseCodecConfigurer other) Create a deep copy of the given `BaseCodecConfigurer`. Since 5.1.12

Method Detail

clone back to summary

clone	back to summary
public abstract CodecConfigurer clone() Redeclares org.springframework.http.codec.CodecConfigurer.clone. Overrides java.lang.Object.clone. Doc from org.springframework.http.codec.CodecConfigurer.clone. Create a copy of this `CodecConfigurer`. The returned clone has its own lists of default and custom codecs and generally can be configured independently. Keep in mind however that codec instances (if any are configured) are themselves not cloned. Returns:CodecConfigurer Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

public abstract CodecConfigurer clone()

Redeclares org.springframework.http.codec.CodecConfigurer.clone.

Doc from org.springframework.http.codec.CodecConfigurer.clone.

Create a copy of this CodecConfigurer. The returned clone has its own lists of default and custom codecs and generally can be configured independently. Keep in mind however that codec instances (if any are configured) are themselves not cloned.

Returns:CodecConfigurer

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

cloneDefaultCodecs back to summary

cloneDefaultCodecs	back to summary
protected abstract BaseDefaultCodecs cloneDefaultCodecs() Subclasses should override this to create a deep copy of `BaseDefaultCodecs` which can be client or server specific. Since 5.1.12

protected abstract BaseDefaultCodecs cloneDefaultCodecs()

Subclasses should override this to create a deep copy of BaseDefaultCodecs which can be client or server specific.

Since: 5.1.12

customCodecs	back to summary
public CodecConfigurer.CustomCodecs customCodecs() Implements org.springframework.http.codec.CodecConfigurer.customCodecs. Doc from org.springframework.http.codec.CodecConfigurer.customCodecs. Register custom HTTP message readers or writers in addition to the ones registered by default. Annotations @Override

customCodecs

back to summary

public CodecConfigurer.CustomCodecs customCodecs()

Implements org.springframework.http.codec.CodecConfigurer.customCodecs.

Doc from org.springframework.http.codec.CodecConfigurer.customCodecs.

Annotations

@Override

defaultCodecs	back to summary
public CodecConfigurer.DefaultCodecs defaultCodecs() Implements org.springframework.http.codec.CodecConfigurer.defaultCodecs. Doc from org.springframework.http.codec.CodecConfigurer.defaultCodecs. Provides a way to customize or replace HTTP message readers and writers registered by default. Annotations @Override

defaultCodecs

back to summary

public CodecConfigurer.DefaultCodecs defaultCodecs()

Implements org.springframework.http.codec.CodecConfigurer.defaultCodecs.

Doc from org.springframework.http.codec.CodecConfigurer.defaultCodecs.

Provides a way to customize or replace HTTP message readers and writers registered by default.

Annotations

@Override

getReaders	back to summary
public List<HttpMessageReader<?>> getReaders() Implements org.springframework.http.codec.CodecConfigurer.getReaders. Doc from org.springframework.http.codec.CodecConfigurer.getReaders. Obtain the configured HTTP message readers. Annotations @Override

getReaders

back to summary

public List<HttpMessageReader<?>> getReaders()

Implements org.springframework.http.codec.CodecConfigurer.getReaders.

Doc from org.springframework.http.codec.CodecConfigurer.getReaders.

Obtain the configured HTTP message readers.

Annotations

@Override

getWriters	back to summary
public List<HttpMessageWriter<?>> getWriters() Implements org.springframework.http.codec.CodecConfigurer.getWriters. Doc from org.springframework.http.codec.CodecConfigurer.getWriters. Obtain the configured HTTP message writers. Annotations @Override

getWriters

back to summary

public List<HttpMessageWriter<?>> getWriters()

Implements org.springframework.http.codec.CodecConfigurer.getWriters.

Doc from org.springframework.http.codec.CodecConfigurer.getWriters.

Obtain the configured HTTP message writers.

Annotations

@Override

registerDefaults back to summary

registerDefaults	back to summary
public void registerDefaults(boolean shouldRegister) Implements org.springframework.http.codec.CodecConfigurer.registerDefaults. Doc from org.springframework.http.codec.CodecConfigurer.registerDefaults. Provides a way to completely turn off registration of default HTTP message readers and writers, and instead rely only on the ones provided via `customCodecs()`. By default this is set to `"true"` in which case default registrations are made; setting this to `false` disables default registrations. Annotations @Override

public void registerDefaults(boolean shouldRegister)

Implements org.springframework.http.codec.CodecConfigurer.registerDefaults.

Doc from org.springframework.http.codec.CodecConfigurer.registerDefaults.

Provides a way to completely turn off registration of default HTTP message readers and writers, and instead rely only on the ones provided via customCodecs().

By default this is set to "true" in which case default registrations are made; setting this to false disables default registrations.

Annotations

@Override

org.springframework.http.codec.support back to summary

protected final Class BaseCodecConfigurer.DefaultCustomCodecs

Class Inheritance

extends Object
implements CustomCodecs

java.lang.Object
org.springframework.http.codec.support.BaseCodecConfigurer.DefaultCustomCodecs

All Implemented Interfaces

org.springframework.http.codec.CodecConfigurer.CustomCodecs

Default implementation of CustomCodecs.

Field Summary

Modifier and Type	Field and Description
private final List<Consumer<CodecConfigurer.DefaultCodecConfig>>	defaultConfigConsumers
private final Map<HttpMessageReader<?>, Boolean>	objectReaders
private final Map<HttpMessageWriter<?>, Boolean>	objectWriters
private final Map<HttpMessageReader<?>, Boolean>	typedReaders
private final Map<HttpMessageWriter<?>, Boolean>	typedWriters

Constructor Summary

Access	Constructor and Description
pack-priv	DefaultCustomCodecs()
pack-priv	DefaultCustomCodecs(BaseCodecConfigurer.DefaultCustomCodecs other) Create a deep copy of the given `DefaultCustomCodecs`.

Method Summary

Modifier and Type	Method and Description
private void	addCodec(Object codec, boolean applyDefaultConfig)
public void	decoder(Decoder<?> the decoder to add decoder) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.decoder. Add a custom `Decoder` internally wrapped with `DecoderHttpMessageReader`).
public void	encoder(Encoder<?> the encoder to add encoder) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.encoder. Add a custom `Encoder`, internally wrapped with `EncoderHttpMessageWriter`.
pack-priv List<Consumer<CodecConfigurer.DefaultCodecConfig>>	getDefaultConfigConsumers()
pack-priv Map<HttpMessageReader<?>, Boolean>	getObjectReaders()
pack-priv Map<HttpMessageWriter<?>, Boolean>	getObjectWriters()
pack-priv Map<HttpMessageReader<?>, Boolean>	getTypedReaders()
pack-priv Map<HttpMessageWriter<?>, Boolean>	getTypedWriters()
public void	reader(HttpMessageReader<?> the reader to add reader) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.reader. Add a custom `HttpMessageReader`.
public void	register(Object the codec to register codec) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.register. Register a custom codec.
public void	registerWithDefaultConfig(Object the codec to register and apply default config to codec) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig. Variant of `register(Object)` that also applies the below properties, if configured, via `defaultCodecs()`: `maxInMemorySize` `enableLoggingRequestDetails`
public void	registerWithDefaultConfig(Object the codec to register codec, Consumer<CodecConfigurer.DefaultCodecConfig> consumer of the default config configConsumer) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig. Variant of `register(Object)` that also allows the caller to apply the properties from `DefaultCodecConfig` to the given codec.
public void	withDefaultCodecConfig(Consumer<CodecConfigurer.DefaultCodecConfig> the default codecs configuration callback codecsConfigConsumer) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.withDefaultCodecConfig. Register a callback for the `configuration` applied to default codecs.
public void	writer(HttpMessageWriter<?> the writer to add writer) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.writer. Add a custom `HttpMessageWriter`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultConfigConsumers	back to summary
private final List<Consumer<CodecConfigurer.DefaultCodecConfig>> defaultConfigConsumers

objectReaders	back to summary
private final Map<HttpMessageReader<?>, Boolean> objectReaders

objectWriters	back to summary
private final Map<HttpMessageWriter<?>, Boolean> objectWriters

typedReaders	back to summary
private final Map<HttpMessageReader<?>, Boolean> typedReaders

typedWriters	back to summary
private final Map<HttpMessageWriter<?>, Boolean> typedWriters

Constructor Detail

DefaultCustomCodecs	back to summary
pack-priv DefaultCustomCodecs()

DefaultCustomCodecs back to summary

DefaultCustomCodecs	back to summary
pack-priv DefaultCustomCodecs(BaseCodecConfigurer.DefaultCustomCodecs other) Create a deep copy of the given `DefaultCustomCodecs`. Since 5.1.12

pack-priv DefaultCustomCodecs(BaseCodecConfigurer.DefaultCustomCodecs other)

Create a deep copy of the given DefaultCustomCodecs.

Since: 5.1.12

Method Detail

addCodec	back to summary
private void addCodec(Object codec, boolean applyDefaultConfig)

decoder back to summary

decoder	back to summary
public void decoder(Decoder<?> decoder) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.decoder. Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.decoder. Add a custom `Decoder` internally wrapped with `DecoderHttpMessageReader`). Parameters decoder:Decoder<?> the decoder to add Annotations @SuppressWarnings:deprecation @Override

public void decoder(Decoder<?> decoder)

Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.decoder.

Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.decoder.

Add a custom Decoder internally wrapped with DecoderHttpMessageReader).

Parameters

decoder:Decoder<?>: the decoder to add

Annotations

@SuppressWarnings:deprecation
@Override

encoder back to summary

encoder	back to summary
public void encoder(Encoder<?> encoder) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.encoder. Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.encoder. Add a custom `Encoder`, internally wrapped with `EncoderHttpMessageWriter`. Parameters encoder:Encoder<?> the encoder to add Annotations @SuppressWarnings:deprecation @Override

public void encoder(Encoder<?> encoder)

Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.encoder.

Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.encoder.

Add a custom Encoder, internally wrapped with EncoderHttpMessageWriter.

Parameters

encoder:Encoder<?>: the encoder to add

Annotations

@SuppressWarnings:deprecation
@Override

getDefaultConfigConsumers	back to summary
pack-priv List<Consumer<CodecConfigurer.DefaultCodecConfig>> getDefaultConfigConsumers()

getObjectReaders	back to summary
pack-priv Map<HttpMessageReader<?>, Boolean> getObjectReaders()

getObjectWriters	back to summary
pack-priv Map<HttpMessageWriter<?>, Boolean> getObjectWriters()

getTypedReaders	back to summary
pack-priv Map<HttpMessageReader<?>, Boolean> getTypedReaders()

getTypedWriters	back to summary
pack-priv Map<HttpMessageWriter<?>, Boolean> getTypedWriters()

reader back to summary

reader	back to summary
public void reader(HttpMessageReader<?> reader) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.reader. Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.reader. Add a custom `HttpMessageReader`. For readers of type `DecoderHttpMessageReader` consider using the shortcut `decoder(Decoder)` instead. Parameters reader:HttpMessageReader<?> the reader to add Annotations @SuppressWarnings:deprecation @Override

public void reader(HttpMessageReader<?> reader)

Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.reader.

Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.reader.

Add a custom HttpMessageReader. For readers of type DecoderHttpMessageReader consider using the shortcut decoder(Decoder) instead.

Parameters

reader:HttpMessageReader<?>: the reader to add

Annotations

@SuppressWarnings:deprecation
@Override

register	back to summary
public void register(Object codec) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.register. Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.register. 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:Object the codec to register Annotations @Override

public void register(Object codec)

Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.register.

Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.register.

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

Parameters

codec:Object: the codec to register

Annotations

@Override

registerWithDefaultConfig back to summary

registerWithDefaultConfig	back to summary
public void registerWithDefaultConfig(Object codec) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig. Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig. Variant of `register(Object)` that also applies the below properties, if configured, via `defaultCodecs()`: `maxInMemorySize` `enableLoggingRequestDetails` The properties are applied every time `getReaders()` or `getWriters()` are used to obtain the list of configured readers or writers. Parameters codec:Object the codec to register and apply default config to Annotations @Override

public void registerWithDefaultConfig(Object codec)

Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig.

Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig.

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

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

Parameters

codec:Object: the codec to register and apply default config to

Annotations

@Override

registerWithDefaultConfig back to summary

registerWithDefaultConfig	back to summary
public void registerWithDefaultConfig(Object codec, Consumer<CodecConfigurer.DefaultCodecConfig> configConsumer) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig. Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig. Variant of `register(Object)` that also allows the caller to apply the properties from `DefaultCodecConfig` to the given codec. If you want to apply all the properties, prefer using `registerWithDefaultConfig(Object)`. The consumer is called every time `getReaders()` or `getWriters()` are used to obtain the list of configured readers or writers. Parameters codec:Object the codec to register configConsumer:Consumer<CodecConfigurer.DefaultCodecConfig> consumer of the default config Annotations @Override

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

Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig.

Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.registerWithDefaultConfig.

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

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

Parameters

codec:Object: the codec to register
configConsumer:Consumer<CodecConfigurer.DefaultCodecConfig>: consumer of the default config

Annotations

@Override

withDefaultCodecConfig back to summary

withDefaultCodecConfig	back to summary
public void withDefaultCodecConfig(Consumer<CodecConfigurer.DefaultCodecConfig> codecsConfigConsumer) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.withDefaultCodecConfig. Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.withDefaultCodecConfig. 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. Parameters codecsConfigConsumer:Consumer<CodecConfigurer.DefaultCodecConfig> the default codecs configuration callback Annotations @SuppressWarnings:deprecation @Override

public void withDefaultCodecConfig(Consumer<CodecConfigurer.DefaultCodecConfig> codecsConfigConsumer)

Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.withDefaultCodecConfig.

Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.withDefaultCodecConfig.

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.

Parameters

codecsConfigConsumer:Consumer<CodecConfigurer.DefaultCodecConfig>: the default codecs configuration callback

Annotations

@SuppressWarnings:deprecation
@Override

writer back to summary

writer	back to summary
public void writer(HttpMessageWriter<?> writer) Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.writer. Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.writer. Add a custom `HttpMessageWriter`. For writers of type `EncoderHttpMessageWriter` consider using the shortcut `encoder(Encoder)` instead. Parameters writer:HttpMessageWriter<?> the writer to add Annotations @SuppressWarnings:deprecation @Override

public void writer(HttpMessageWriter<?> writer)

Implements org.springframework.http.codec.CodecConfigurer.CustomCodecs.writer.

Doc from org.springframework.http.codec.CodecConfigurer.CustomCodecs.writer.

Add a custom HttpMessageWriter. For writers of type EncoderHttpMessageWriter consider using the shortcut encoder(Encoder) instead.

Parameters

writer:HttpMessageWriter<?>: the writer to add

Annotations

@SuppressWarnings:deprecation
@Override

pack-priv abstract Class BaseCodecConfigurer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected final Class BaseCodecConfigurer.DefaultCustomCodecs

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail