org.springframework.http.codec

Interface ServerHttpMessageReader<T>

All Superinterfaces:

HttpMessageReader<T>

All Known Implementing Classes:

AbstractServerHttpMessageReader, Jackson2ServerHttpMessageReader

public interface ServerHttpMessageReader<T>
extends HttpMessageReader<T>

Server oriented HttpMessageReader that allows to resolve hints using annotations or perform additional operation using ServerHttpRequest or ServerHttpResponse.

Since:

5.0

Author:

Sebastien Deleuze

Method Summary

Modifier and Type	Method and Description
<any>	read(ResolvableType streamType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response, java.util.Map<java.lang.String,java.lang.Object> hints) Read a Flux of the given type form the given input message with additional server related parameters which could be used to create some hints or set the response status for example.
<any>	readMono(ResolvableType streamType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response, java.util.Map<java.lang.String,java.lang.Object> hints) Read a Mono of the given type form the given input message with additional server related parameters which could be used to create some hints or set the response status for example.

Methods inherited from interface org.springframework.http.codec.HttpMessageReader

canRead, getReadableMediaTypes, read, readMono

Method Detail

read

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

Read a Flux of the given type form the given input message with additional server related parameters which could be used to create some hints or set the response status for example. Return hints that can be used to customize how the body should be read

Parameters:

streamType - the original type used in the method parameter. For annotation based controllers, the MethodParameter is available via ResolvableType.getSource().

elementType - the stream element type to return Typically the value of a Content-Type header.

request - the current HTTP request

response - the current HTTP response

hints - additional information about how to read the body

Returns:

the converted Flux of elements

readMono

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

Read a Mono of the given type form the given input message with additional server related parameters which could be used to create some hints or set the response status for example. Return hints that can be used to customize how the body should be read

Parameters:

streamType - the original type used in the method parameter. For annotation based controllers, the MethodParameter is available via ResolvableType.getSource().

elementType - the stream element type to return Typically the value of a Content-Type header.

request - the current HTTP request

response - the current HTTP response

hints - additional information about how to read the body

Returns:

the converted Mono of object