org.springframework.http.codec.support

Class BaseCodecConfigurer

java.lang.Object

org.springframework.http.codec.support.BaseCodecConfigurer

All Implemented Interfaces:

CodecConfigurer

Direct Known Subclasses:

DefaultClientCodecConfigurer, DefaultServerCodecConfigurer

class BaseCodecConfigurer
extends java.lang.Object
implements CodecConfigurer

Default implementation of CodecConfigurer that serves as a base for client and server specific variants.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.springframework.http.codec.CodecConfigurer

CodecConfigurer.CustomCodecs, CodecConfigurer.DefaultCodecs

Field Summary

Fields

Modifier and Type	Field and Description
private BaseCodecConfigurer.DefaultCustomCodecs	customCodecs
private BaseDefaultCodecs	defaultCodecs

Constructor Summary

Constructors

Constructor and Description
BaseCodecConfigurer(BaseDefaultCodecs defaultCodecs) Constructor with the base BaseDefaultCodecs to use, which can be a client or server specific variant.

Method Summary

Modifier and Type	Method and Description
CodecConfigurer.CustomCodecs	customCodecs() Register custom HTTP message readers or writers in addition to the ones registered by default.
CodecConfigurer.DefaultCodecs	defaultCodecs() Provides a way to customize or replace HTTP message readers and writers registered by default.
java.util.List<HttpMessageReader<?>>	getReaders() Obtain the configured HTTP message readers.
java.util.List<HttpMessageWriter<?>>	getWriters() Obtain the configured HTTP message writers.
protected java.util.List<HttpMessageWriter<?>>	getWritersInternal(boolean forMultipart) Internal method that returns the configured writers.
void	registerDefaults(boolean shouldRegister) Provides a way to completely turn off registration of default HTTP message readers and writers, and instead rely only on the ones provided via CodecConfigurer.customCodecs().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultCodecs

private final BaseDefaultCodecs defaultCodecs

customCodecs

private final BaseCodecConfigurer.DefaultCustomCodecs customCodecs

Constructor Detail

BaseCodecConfigurer

BaseCodecConfigurer(BaseDefaultCodecs defaultCodecs)

Constructor with the base BaseDefaultCodecs to use, which can be a client or server specific variant.

Method Detail

defaultCodecs

public CodecConfigurer.DefaultCodecs defaultCodecs()

Description copied from interface: CodecConfigurer

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

Specified by:

defaultCodecs in interface CodecConfigurer

See Also:

CodecConfigurer.registerDefaults(boolean)

registerDefaults

public void registerDefaults(boolean shouldRegister)

Description copied from interface: CodecConfigurer

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

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

Specified by:

registerDefaults in interface CodecConfigurer

customCodecs

public CodecConfigurer.CustomCodecs customCodecs()

Description copied from interface: CodecConfigurer

Register custom HTTP message readers or writers in addition to the ones registered by default.

Specified by:

customCodecs in interface CodecConfigurer

getReaders

public java.util.List<HttpMessageReader<?>> getReaders()

Description copied from interface: CodecConfigurer

Obtain the configured HTTP message readers.

Specified by:

getReaders in interface CodecConfigurer

getWriters

public java.util.List<HttpMessageWriter<?>> getWriters()

Description copied from interface: CodecConfigurer

Obtain the configured HTTP message writers.

Specified by:

getWriters in interface CodecConfigurer

getWritersInternal

protected java.util.List<HttpMessageWriter<?>> getWritersInternal(boolean forMultipart)

Internal method that returns the configured writers.

Parameters:

forMultipart - whether to returns writers for general use ("false"), or for multipart requests only ("true"). Generally the two sets are the same except for the multipart writer itself.