Package org.springframework.http.codec
Interface ServerCodecConfigurer
- All Superinterfaces:
CodecConfigurer
- All Known Implementing Classes:
DefaultServerCodecConfigurer
public interface ServerCodecConfigurer extends CodecConfigurer
Extension ofCodecConfigurer
for HTTP message reader and writer options relevant on the server side.HTTP message readers for the following are registered by default:
ByteBuffer
DataBuffer
Resource
String
MultiValueMap<String,String>
for form dataMultiValueMap<String,Object>
for multipart data- JSON and Smile, if Jackson is present
- XML, if JAXB2 is present
byte[]
HTTP message writers registered by default:
ByteBuffer
DataBuffer
Resource
String
MultiValueMap<String,String>
for form data- JSON and Smile, if Jackson is present
- XML, if JAXB2 is present
- Server-Sent Events
byte[]
- Since:
- 5.0
- Author:
- Rossen Stoyanchev
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ServerCodecConfigurer.ServerDefaultCodecs
CodecConfigurer.DefaultCodecs
extension with extra client-side options.Nested classes/interfaces inherited from interface org.springframework.http.codec.CodecConfigurer
CodecConfigurer.CustomCodecs, CodecConfigurer.DefaultCodecConfig, CodecConfigurer.DefaultCodecs
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description ServerCodecConfigurer
clone()
Create a copy of thisCodecConfigurer
.static ServerCodecConfigurer
create()
Static factory method for aServerCodecConfigurer
.ServerCodecConfigurer.ServerDefaultCodecs
defaultCodecs()
Provides a way to customize or replace HTTP message readers and writers registered by default.Methods inherited from interface org.springframework.http.codec.CodecConfigurer
customCodecs, getReaders, getWriters, registerDefaults
Method Detail
defaultCodecs
ServerCodecConfigurer.ServerDefaultCodecs 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.
- Specified by:
defaultCodecs
in interfaceCodecConfigurer
- See Also:
CodecConfigurer.registerDefaults(boolean)
clone
ServerCodecConfigurer clone()
Create a copy of thisCodecConfigurer
. 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..- Specified by:
clone
in interfaceCodecConfigurer
create
static ServerCodecConfigurer create()
Static factory method for aServerCodecConfigurer
.