org.springframework.http.codec

public Interface HttpMessageDecoder<T>

Known Direct Implementers

extends Decoder<T>org.springframework.http.codec.json.AbstractJackson2Decoder

Type Parameters

<T>: the type of elements in the output stream

Imports

java.util.Map, org.springframework.core.ResolvableType, org.springframework.core.codec.Decoder, org.springframework.http.server.reactive.ServerHttpRequest, .ServerHttpResponse

Extension of Decoder exposing extra methods relevant in the context of HTTP request or response body decoding.

Author: Rossen Stoyanchev
Since: 5.0

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public Map<String, Object>	Returns: a Map with hints, possibly empty getDecodeHints(ResolvableType the actual target type to decode to, possibly a reactive wrapper and sourced from `org.springframework.core.MethodParameter`, i.e. providing access to method parameter annotations actualType, ResolvableType the element type within `Flux/Mono` that we're trying to decode to elementType, ServerHttpRequest the current request request, ServerHttpResponse the current response response) Get decoding hints based on the server request or annotations on the target controller method parameter.

public Map<String, Object>

Returns:

a Map with hints, possibly empty

getDecodeHints(ResolvableType

the actual target type to decode to, possibly a reactive wrapper and sourced from org.springframework.core.MethodParameter, i.e. providing access to method parameter annotations

actualType, ResolvableType

the element type within Flux/Mono that we're trying to decode to

elementType, ServerHttpRequest

the current request

request, ServerHttpResponse

the current response

response)

Get decoding hints based on the server request or annotations on the target controller method parameter.

Inherited from org.springframework.core.codec.Decoder:: canDecode decode decode decodeToMono getDecodableMimeTypes getDecodableMimeTypes

Method Detail

getDecodeHints back to summary

getDecodeHints	back to summary
public Map<String, Object> getDecodeHints(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response) Get decoding hints based on the server request or annotations on the target controller method parameter. Parameters actualType:ResolvableType the actual target type to decode to, possibly a reactive wrapper and sourced from `org.springframework.core.MethodParameter`, i.e. providing access to method parameter annotations elementType:ResolvableType the element type within `Flux/Mono` that we're trying to decode to request:ServerHttpRequest the current request response:ServerHttpResponse the current response Returns:Map<String, Object> a Map with hints, possibly empty

public Map<String, Object> getDecodeHints(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response)

Get decoding hints based on the server request or annotations on the target controller method parameter.

Parameters

actualType:ResolvableType: the actual target type to decode to, possibly a reactive wrapper and sourced from org.springframework.core.MethodParameter, i.e. providing access to method parameter annotations
elementType:ResolvableType: the element type within Flux/Mono that we're trying to decode to
request:ServerHttpRequest: the current request
response:ServerHttpResponse: the current response

Returns:Map<String, Object>

a Map with hints, possibly empty