Top Description Inners Methods
org.springframework.http.codec

public Interface ServerCodecConfigurer

extends CodecConfigurer
Known Direct Implementers
org.springframework.http.codec.support.DefaultServerCodecConfigurer
Imports
org.springframework.core.codec.Encoder
Extension of CodecConfigurer for HTTP message reader and writer options relevant on the server side.

HTTP message readers for the following are registered by default:

HTTP message writers registered by default:

Author
Rossen Stoyanchev
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
ServerCodecConfigurer.ServerDefaultCodecs

CodecConfigurer.DefaultCodecs extension with extra server-side options.

Method Summary

Modifier and TypeMethod and Description
public ServerCodecConfigurer
clone()

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

Create a copy of this CodecConfigurer.

public static ServerCodecConfigurer
create()

Static factory method for a ServerCodecConfigurer.

public ServerCodecConfigurer.ServerDefaultCodecs
defaultCodecs()

Redeclares org.springframework.http.codec.CodecConfigurer.defaultCodecs.

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

Inherited from org.springframework.http.codec.CodecConfigurer:
customCodecsgetReadersgetWritersregisterDefaults

Method Detail

cloneback to summary
public ServerCodecConfigurer 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..

Annotations
@Override
createback to summary
public static ServerCodecConfigurer create()

Static factory method for a ServerCodecConfigurer.

defaultCodecsback to summary
public ServerCodecConfigurer.ServerDefaultCodecs defaultCodecs()

Redeclares 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.

On the server side, built-in default also include customizations related to the encoder for SSE.

Annotations
@Override
org.springframework.http.codec back to summary

public Interface ServerCodecConfigurer.ServerDefaultCodecs

extends DefaultCodecs
Known Direct Implementers
org.springframework.http.codec.support.ServerDefaultCodecsImpl
CodecConfigurer.DefaultCodecs extension with extra server-side options.

Method Summary

Modifier and TypeMethod and Description
public void
serverSentEventEncoder(Encoder<?> encoder)

Configure the Encoder to use for Server-Sent Events.

Inherited from org.springframework.http.codec.CodecConfigurer.DefaultCodecs:
configureDefaultCodecenableLoggingRequestDetailsjackson2JsonDecoderjackson2JsonEncoderjackson2SmileDecoderjackson2SmileEncoderjaxb2Decoderjaxb2EncoderkotlinSerializationCborDecoderkotlinSerializationCborEncoderkotlinSerializationJsonDecoderkotlinSerializationJsonEncoderkotlinSerializationProtobufDecoderkotlinSerializationProtobufEncodermaxInMemorySizemultipartCodecsmultipartReaderprotobufDecoderprotobufEncoder

Method Detail

serverSentEventEncoderback to summary
public void serverSentEventEncoder(Encoder<?> encoder)

Configure the Encoder to use for Server-Sent Events.

By default if this is not set, and Jackson is available, the jackson2JsonEncoder override is used instead. Use this method to customize the SSE encoder.