Top Description Interfaces Classes

[default module]

Package org.springframework.http.codec

Annotations

@NonNullApi
@NonNullFields

Imports

org.springframework.lang.NonNullApi, .NonNullFields

Provides implementations of org.springframework.core.codec.Encoder and org.springframework.core.codec.Decoder for web use.

Also declares a high-level org.springframework.http.codec.HttpMessageReader and org.springframework.http.codec.HttpMessageWriter for reading and writing the body of HTTP requests and responses.

Interface Summary

Modifier and Type	Interface and Description
public interface	ClientCodecConfigurer Extension of `CodecConfigurer` for HTTP message reader and writer options relevant on the client side.
public interface	CodecConfigurer Defines a common interface for configuring either client or server HTTP message readers and writers.
public interface	HttpMessageDecoder< the type of elements in the output stream T> Extension of `Decoder` exposing extra methods relevant in the context of HTTP request or response body decoding.
public interface	HttpMessageEncoder< the type of elements in the input stream T> Extension of `Encoder` exposing extra methods relevant in the context of HTTP request or response body encoding.
public interface	HttpMessageReader< the type of objects in the decoded output stream T> Strategy for reading from a `ReactiveHttpInputMessage` and decoding the stream of bytes to Objects of type `<T>`.
public interface	HttpMessageWriter< the type of objects in the input stream T> Strategy for encoding a stream of objects of type `<T>` and writing the encoded stream of bytes to an `ReactiveHttpOutputMessage`.
public interface	ServerCodecConfigurer Extension of `CodecConfigurer` for HTTP message reader and writer options relevant on the server side.

Class Summary

Modifier and Type	Class and Description
pack-priv class	CodecConfigurerFactory Internal delegate for loading the default codec configurer class names.
pack-priv class	CodecConfigurerRuntimeHints `RuntimeHintsRegistrar` implementation that registers runtime hints for implementations listed in `CodecConfigurer.properties`.
public class	DecoderHttpMessageReader< the type of objects in the decoded output stream T> `HttpMessageReader` that wraps and delegates to a `Decoder`.
public class	EncoderHttpMessageWriter< the type of objects in the input stream T> `HttpMessageWriter` that wraps and delegates to an `Encoder`.
public class	FormHttpMessageReader Implementation of an `HttpMessageReader` to read HTML form data, i.e. request body with media type `"application/x-www-form-urlencoded"`.
public class	FormHttpMessageWriter `HttpMessageWriter` for writing a `MultiValueMap<String, String>` as HTML form data, i.e. `"application/x-www-form-urlencoded"`, to the body of a request.
public abstract class	KotlinSerializationBinaryDecoder< the type of `BinaryFormat` T extends kotlinx.serialization.BinaryFormat> Abstract base class for `Decoder` implementations that defer to Kotlin binary serializers.
public abstract class	KotlinSerializationBinaryEncoder< the type of `BinaryFormat` T extends kotlinx.serialization.BinaryFormat> Abstract base class for `Encoder` implementations that defer to Kotlin binary serializers.
public abstract class	KotlinSerializationStringDecoder< the type of `StringFormat` T extends kotlinx.serialization.StringFormat> Abstract base class for `Decoder` implementations that defer to Kotlin string serializers.
public abstract class	KotlinSerializationStringEncoder< the type of `StringFormat` T extends kotlinx.serialization.StringFormat> Abstract base class for `Encoder` implementations that defer to Kotlin string serializers.
public abstract class	KotlinSerializationSupport< the type of `SerialFormat` T extends kotlinx.serialization.SerialFormat> Base class providing support methods for encoding and decoding with Kotlin serialization.
public class	LoggingCodecSupport Base class for `org.springframework.core.codec.Encoder`, `org.springframework.core.codec.Decoder`, `HttpMessageReader`, or `HttpMessageWriter` that uses a logger and shows potentially sensitive request data.
public class	ResourceHttpMessageReader `HttpMessageReader` that wraps and delegates to a `ResourceDecoder` that extracts the filename from the `"Content-Disposition"` header, if available, and passes it as the `ResourceDecoder#FILENAME_HINT`.
public class	ResourceHttpMessageWriter `HttpMessageWriter` that can write a `Resource`.
public class	ServerSentEvent< the type of data that this event contains T> Representation for a Server-Sent Event for use with Spring's reactive Web support.
public class	ServerSentEventHttpMessageReader Reader that supports a stream of `ServerSentEvents` and also plain `Objects` which is the same as an `ServerSentEvent` with data only.
public class	ServerSentEventHttpMessageWriter `HttpMessageWriter` for `"text/event-stream"` responses.