org.springframework.http.codec

Interface HttpMessageReader<T>

All Known Subinterfaces:

ServerHttpMessageReader<T>

All Known Implementing Classes:

AbstractServerHttpMessageReader, DecoderHttpMessageReader, FormHttpMessageReader, Jackson2ServerHttpMessageReader, ServerSentEventHttpMessageReader

public interface HttpMessageReader<T>

Strategy interface that specifies a reader that can convert from the HTTP request body from a stream of bytes to Objects.

Since:

5.0

Author:

Rossen Stoyanchev, Arjen Poutsma, Sebastien Deleuze

Method Summary

Modifier and Type	Method and Description
boolean	canRead(org.springframework.core.ResolvableType elementType, MediaType mediaType) Indicates whether the given class can be read by this converter.
List<MediaType>	getReadableMediaTypes() Return the list of MediaType objects that can be read by this converter.
reactor.core.publisher.Flux<T>	read(org.springframework.core.ResolvableType elementType, ReactiveHttpInputMessage inputMessage, Map<String,Object> hints) Read a Flux of the given type form the given input message, and returns it.
reactor.core.publisher.Mono<T>	readMono(org.springframework.core.ResolvableType elementType, ReactiveHttpInputMessage inputMessage, Map<String,Object> hints) Read a Mono of the given type form the given input message, and returns it.

Method Detail

canRead

boolean canRead(org.springframework.core.ResolvableType elementType,
                MediaType mediaType)

Indicates whether the given class can be read by this converter.

Parameters:

elementType - the stream element type to test for readability

mediaType - the media type to read, can be null if not specified. Typically the value of a Content-Type header.

Returns:

true if readable; false otherwise

read

reactor.core.publisher.Flux<T> read(org.springframework.core.ResolvableType elementType,
                                    ReactiveHttpInputMessage inputMessage,
                                    Map<String,Object> hints)

Read a Flux of the given type form the given input message, and returns it.

Parameters:

elementType - the stream element type to return. This type must have previously been passed to the canRead method of this interface, which must have returned true.

inputMessage - the HTTP input message to read from

hints - additional information about how to read the body

Returns:

the converted Flux of elements

readMono

reactor.core.publisher.Mono<T> readMono(org.springframework.core.ResolvableType elementType,
                                        ReactiveHttpInputMessage inputMessage,
                                        Map<String,Object> hints)

Read a Mono of the given type form the given input message, and returns it.

Parameters:

elementType - the stream element type to return. This type must have previously been passed to the canRead method of this interface, which must have returned true.

inputMessage - the HTTP input message to read from

hints - additional information about how to read the body

Returns:

the converted Mono of object

getReadableMediaTypes

List<MediaType> getReadableMediaTypes()

Return the list of MediaType objects that can be read by this converter.

Returns:

the list of supported readable media types