org.springframework.http.codec

Class AbstractServerHttpMessageReader<T>

java.lang.Object

org.springframework.http.codec.AbstractServerHttpMessageReader<T>

All Implemented Interfaces:

HttpMessageReader<T>, ServerHttpMessageReader<T>

Direct Known Subclasses:

Jackson2ServerHttpMessageReader

public abstract class AbstractServerHttpMessageReader<T>
extends java.lang.Object
implements ServerHttpMessageReader<T>

HttpMessageReader wrapper that implements ServerHttpMessageReader in order to allow providing hints to the nested reader or setting the response status for example, by implementing resolveReadHints(ResolvableType, ResolvableType, ServerHttpRequest).

Since:

5.0

Author:

Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field and Description
private HttpMessageReader<T>	reader

Constructor Summary

Constructors

Constructor and Description
AbstractServerHttpMessageReader(HttpMessageReader<T> reader)

Method Summary

Modifier and Type	Method and Description
boolean	canRead(ResolvableType elementType, MediaType mediaType) Indicates whether the given class can be read by this converter.
java.util.List<MediaType>	getReadableMediaTypes() Return the list of MediaType objects that can be read by this converter.
<any>	read(ResolvableType elementType, ReactiveHttpInputMessage inputMessage, java.util.Map<java.lang.String,java.lang.Object> hints) Read a Flux of the given type form the given input message, and returns it.
<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 elementType, ReactiveHttpInputMessage inputMessage, java.util.Map<java.lang.String,java.lang.Object> hints) Read a Mono of the given type form the given input message, and returns it.
<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.
protected abstract java.util.Map<java.lang.String,java.lang.Object>	resolveReadHints(ResolvableType streamType, ResolvableType elementType, ServerHttpRequest request) Invoked before reading the request to resolve hints by read(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse, Map).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

reader

private HttpMessageReader<T> reader

Constructor Detail

AbstractServerHttpMessageReader

public AbstractServerHttpMessageReader(HttpMessageReader<T> reader)

Method Detail

canRead

public boolean canRead(ResolvableType elementType,
                       MediaType mediaType)

Description copied from interface: HttpMessageReader

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

Specified by:

canRead in interface HttpMessageReader<T>

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

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

Description copied from interface: HttpMessageReader

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

Specified by:

read in interface HttpMessageReader<T>

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

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

Description copied from interface: HttpMessageReader

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

Specified by:

readMono in interface HttpMessageReader<T>

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

public java.util.List<MediaType> getReadableMediaTypes()

Description copied from interface: HttpMessageReader

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

Specified by:

getReadableMediaTypes in interface HttpMessageReader<T>

Returns:

the list of supported readable media types

read

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

Description copied from interface: ServerHttpMessageReader

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

Specified by:

read in interface ServerHttpMessageReader<T>

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

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

Description copied from interface: ServerHttpMessageReader

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

Specified by:

readMono in interface ServerHttpMessageReader<T>

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

resolveReadHints

protected abstract java.util.Map<java.lang.String,java.lang.Object> resolveReadHints(ResolvableType streamType,
                                                                                     ResolvableType elementType,
                                                                                     ServerHttpRequest request)

Invoked before reading the request to resolve hints by read(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse, Map).

Parameters:

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

elementType - the stream element type to process

request - the current HTTP request

Returns:

Additional information about how to write the body