org.springframework.http.codec.support

Class BaseDefaultCodecs

java.lang.Object

org.springframework.http.codec.support.BaseDefaultCodecs

All Implemented Interfaces:

CodecConfigurer.DefaultCodecs

Direct Known Subclasses:

ClientDefaultCodecsImpl, ServerDefaultCodecsImpl

class BaseDefaultCodecs
extends java.lang.Object
implements CodecConfigurer.DefaultCodecs

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

Author:

Rossen Stoyanchev, Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	enableLoggingRequestDetails
private Decoder<?>	jackson2JsonDecoder
private Encoder<?>	jackson2JsonEncoder
(package private) static boolean	jackson2Present
private static boolean	jackson2SmilePresent
private Decoder<?>	jaxb2Decoder
private Encoder<?>	jaxb2Encoder
private static boolean	jaxb2Present
private Decoder<?>	protobufDecoder
private Encoder<?>	protobufEncoder
private static boolean	protobufPresent
private boolean	registerDefaults

Constructor Summary

Constructors

Constructor and Description
BaseDefaultCodecs()

Method Summary

Modifier and Type	Method and Description
void	enableLoggingRequestDetails(boolean enable) Whether to log form data at DEBUG level, and headers at TRACE level.
protected void	extendObjectReaders(java.util.List<HttpMessageReader<?>> objectReaders) Hook for client or server specific Object readers.
protected void	extendObjectWriters(java.util.List<HttpMessageWriter<?>> objectWriters) Hook for client or server specific Object writers.
protected void	extendTypedReaders(java.util.List<HttpMessageReader<?>> typedReaders) Hook for client or server specific typed readers.
protected void	extendTypedWriters(java.util.List<HttpMessageWriter<?>> typedWriters) Hook for client or server specific typed writers.
(package private) java.util.List<HttpMessageReader<?>>	getCatchAllReaders() Return readers that need to be at the end, after all others.
(package private) java.util.List<HttpMessageWriter<?>>	getCatchAllWriters() Return writers that need to be at the end, after all others.
protected Decoder<?>	getJackson2JsonDecoder()
protected Encoder<?>	getJackson2JsonEncoder()
(package private) java.util.List<HttpMessageReader<?>>	getObjectReaders() Return Object readers (JSON, XML, SSE).
(package private) java.util.List<HttpMessageWriter<?>>	getObjectWriters(boolean forMultipart) Return Object writers (JSON, XML, SSE).
(package private) java.util.List<HttpMessageReader<?>>	getTypedReaders() Return readers that support specific types.
(package private) java.util.List<HttpMessageWriter<?>>	getTypedWriters(boolean forMultipart) Return writers that support specific types.
protected boolean	isEnableLoggingRequestDetails()
void	jackson2JsonDecoder(Decoder<?> decoder) Override the default Jackson JSON Decoder.
void	jackson2JsonEncoder(Encoder<?> encoder) Override the default Jackson JSON Encoder.
void	jaxb2Decoder(Decoder<?> decoder) Override the default JAXB2 Decoder.
void	jaxb2Encoder(Encoder<?> encoder) Override the default JABX2 Encoder.
void	protobufDecoder(Decoder<?> decoder) Override the default Protobuf Decoder.
void	protobufEncoder(Encoder<?> encoder) Override the default Protobuf Encoder.
(package private) void	registerDefaults(boolean registerDefaults) Delegate method used from BaseCodecConfigurer.registerDefaults(boolean).

Methods inherited from class java.lang.Object

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

Field Detail

jackson2Present

static final boolean jackson2Present

jackson2SmilePresent

private static final boolean jackson2SmilePresent

jaxb2Present

private static final boolean jaxb2Present

protobufPresent

private static final boolean protobufPresent

jackson2JsonDecoder

@Nullable
private Decoder<?> jackson2JsonDecoder

jackson2JsonEncoder

@Nullable
private Encoder<?> jackson2JsonEncoder

protobufDecoder

@Nullable
private Decoder<?> protobufDecoder

protobufEncoder

@Nullable
private Encoder<?> protobufEncoder

jaxb2Decoder

@Nullable
private Decoder<?> jaxb2Decoder

jaxb2Encoder

@Nullable
private Encoder<?> jaxb2Encoder

enableLoggingRequestDetails

private boolean enableLoggingRequestDetails

registerDefaults

private boolean registerDefaults

Constructor Detail

BaseDefaultCodecs

BaseDefaultCodecs()

Method Detail

jackson2JsonDecoder

public void jackson2JsonDecoder(Decoder<?> decoder)

Description copied from interface: CodecConfigurer.DefaultCodecs

Override the default Jackson JSON Decoder.

Specified by:

jackson2JsonDecoder in interface CodecConfigurer.DefaultCodecs

Parameters:

decoder - the decoder instance to use

See Also:

Jackson2JsonDecoder

jackson2JsonEncoder

public void jackson2JsonEncoder(Encoder<?> encoder)

Description copied from interface: CodecConfigurer.DefaultCodecs

Override the default Jackson JSON Encoder.

Specified by:

jackson2JsonEncoder in interface CodecConfigurer.DefaultCodecs

Parameters:

encoder - the encoder instance to use

See Also:

Jackson2JsonEncoder

protobufDecoder

public void protobufDecoder(Decoder<?> decoder)

Description copied from interface: CodecConfigurer.DefaultCodecs

Override the default Protobuf Decoder.

Specified by:

protobufDecoder in interface CodecConfigurer.DefaultCodecs

Parameters:

decoder - the decoder instance to use

See Also:

ProtobufDecoder

protobufEncoder

public void protobufEncoder(Encoder<?> encoder)

Description copied from interface: CodecConfigurer.DefaultCodecs

Override the default Protobuf Encoder.

Specified by:

protobufEncoder in interface CodecConfigurer.DefaultCodecs

Parameters:

encoder - the encoder instance to use

See Also:

ProtobufEncoder, ProtobufHttpMessageWriter

jaxb2Decoder

public void jaxb2Decoder(Decoder<?> decoder)

Description copied from interface: CodecConfigurer.DefaultCodecs

Override the default JAXB2 Decoder.

Specified by:

jaxb2Decoder in interface CodecConfigurer.DefaultCodecs

Parameters:

decoder - the decoder instance to use

See Also:

Jaxb2XmlDecoder

jaxb2Encoder

public void jaxb2Encoder(Encoder<?> encoder)

Description copied from interface: CodecConfigurer.DefaultCodecs

Override the default JABX2 Encoder.

Specified by:

jaxb2Encoder in interface CodecConfigurer.DefaultCodecs

Parameters:

encoder - the encoder instance to use

See Also:

Jaxb2XmlEncoder

enableLoggingRequestDetails

public void enableLoggingRequestDetails(boolean enable)

Description copied from interface: CodecConfigurer.DefaultCodecs

Whether to log form data at DEBUG level, and headers at TRACE level. Both may contain sensitive information.

By default set to false so that request details are not shown.

Specified by:

enableLoggingRequestDetails in interface CodecConfigurer.DefaultCodecs

Parameters:

enable - whether to enable or not

isEnableLoggingRequestDetails

protected boolean isEnableLoggingRequestDetails()

registerDefaults

void registerDefaults(boolean registerDefaults)

Delegate method used from BaseCodecConfigurer.registerDefaults(boolean).

getTypedReaders

final java.util.List<HttpMessageReader<?>> getTypedReaders()

Return readers that support specific types.

extendTypedReaders

protected void extendTypedReaders(java.util.List<HttpMessageReader<?>> typedReaders)

Hook for client or server specific typed readers.

getObjectReaders

final java.util.List<HttpMessageReader<?>> getObjectReaders()

Return Object readers (JSON, XML, SSE).

extendObjectReaders

protected void extendObjectReaders(java.util.List<HttpMessageReader<?>> objectReaders)

Hook for client or server specific Object readers.

getCatchAllReaders

final java.util.List<HttpMessageReader<?>> getCatchAllReaders()

Return readers that need to be at the end, after all others.

getTypedWriters

final java.util.List<HttpMessageWriter<?>> getTypedWriters(boolean forMultipart)

Return writers that support specific types.

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.

extendTypedWriters

protected void extendTypedWriters(java.util.List<HttpMessageWriter<?>> typedWriters)

Hook for client or server specific typed writers.

getObjectWriters

final java.util.List<HttpMessageWriter<?>> getObjectWriters(boolean forMultipart)

Return Object writers (JSON, XML, SSE).

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.

extendObjectWriters

protected void extendObjectWriters(java.util.List<HttpMessageWriter<?>> objectWriters)

Hook for client or server specific Object writers.

getCatchAllWriters

java.util.List<HttpMessageWriter<?>> getCatchAllWriters()

Return writers that need to be at the end, after all others.

getJackson2JsonDecoder

protected Decoder<?> getJackson2JsonDecoder()

getJackson2JsonEncoder

protected Encoder<?> getJackson2JsonEncoder()