org.springframework.http.codec

Interface HttpMessageReader<T>

Type Parameters:

T - the type of objects in the decoded output stream

All Known Implementing Classes:

DecoderHttpMessageReader, FormHttpMessageReader, MultipartHttpMessageReader, ServerSentEventHttpMessageReader, SynchronossPartHttpMessageReader

public interface HttpMessageReader<T>

Strategy for reading from a ReactiveHttpInputMessage and decoding the stream of bytes to Objects of type <T>.

Since:

5.0

Author:

Rossen Stoyanchev, Arjen Poutsma, Sebastien Deleuze

Method Summary

Modifier and Type	Method and Description
boolean	canRead(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this reader.
java.util.List<MediaType>	getReadableMediaTypes() Return the MediaType's that this reader supports.
<any>	read(ResolvableType elementType, ReactiveHttpInputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Read from the input message and encode to a stream of objects.
default <any>	read(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response, java.util.Map<java.lang.String,java.lang.Object> hints) Server-side only alternative to read(ResolvableType, ReactiveHttpInputMessage, Map) with additional context available.
<any>	readMono(ResolvableType elementType, ReactiveHttpInputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Read from the input message and encode to a single object.
default <any>	readMono(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response, java.util.Map<java.lang.String,java.lang.Object> hints) Server-side only alternative to readMono(ResolvableType, ReactiveHttpInputMessage, Map) with additional, context available.

Method Detail

getReadableMediaTypes

java.util.List<MediaType> getReadableMediaTypes()

Return the MediaType's that this reader supports.

canRead

boolean canRead(ResolvableType elementType,
                @Nullable
                MediaType mediaType)

Whether the given object type is supported by this reader.

Parameters:

elementType - the type of object to check

mediaType - the media type for the read (possibly null)

Returns:

true if readable, false otherwise

read

<any> read(ResolvableType elementType,
           ReactiveHttpInputMessage message,
           java.util.Map<java.lang.String,java.lang.Object> hints)

Read from the input message and encode to a stream of objects.

Parameters:

elementType - the type of objects in the stream which must have been previously checked via canRead(ResolvableType, MediaType)

message - the message to read from

hints - additional information about how to read and decode the input

Returns:

the decoded stream of elements

readMono

<any> readMono(ResolvableType elementType,
               ReactiveHttpInputMessage message,
               java.util.Map<java.lang.String,java.lang.Object> hints)

Read from the input message and encode to a single object.

Parameters:

elementType - the type of objects in the stream which must have been previously checked via canRead(ResolvableType, MediaType)

message - the message to read from

hints - additional information about how to read and decode the input

Returns:

the decoded object

read

default <any> read(ResolvableType actualType,
                   ResolvableType elementType,
                   ServerHttpRequest request,
                   ServerHttpResponse response,
                   java.util.Map<java.lang.String,java.lang.Object> hints)

Server-side only alternative to read(ResolvableType, ReactiveHttpInputMessage, Map) with additional context available.

Parameters:

actualType - the actual type of the target method parameter; for annotated controllers, the MethodParameter can be accessed via ResolvableType.getSource().

elementType - the type of Objects in the output stream

request - the current request

response - the current response

hints - additional information about how to read the body

Returns:

the decoded stream of elements

readMono

default <any> readMono(ResolvableType actualType,
                       ResolvableType elementType,
                       ServerHttpRequest request,
                       ServerHttpResponse response,
                       java.util.Map<java.lang.String,java.lang.Object> hints)

Server-side only alternative to readMono(ResolvableType, ReactiveHttpInputMessage, Map) with additional, context available.

Parameters:

actualType - the actual type of the target method parameter; for annotated controllers, the MethodParameter can be accessed via ResolvableType.getSource().

elementType - the type of Objects in the output stream

request - the current request

response - the current response

hints - additional information about how to read the body

Returns:

the decoded stream of elements