org.springframework.http.codec

Class FormHttpMessageReader

java.lang.Object

org.springframework.http.codec.FormHttpMessageReader

All Implemented Interfaces:

HttpMessageReader<org.springframework.util.MultiValueMap<String,String>>

public class FormHttpMessageReader
extends Object
implements HttpMessageReader<org.springframework.util.MultiValueMap<String,String>>

Implementation of an HttpMessageReader to read HTML form data, i.e. request body with media type "application/x-www-form-urlencoded".

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
FormHttpMessageReader()

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.
Charset	getDefaultCharset() Return the configured default charset.
List<MediaType>	getReadableMediaTypes() Return the list of MediaType objects that can be read by this converter.
reactor.core.publisher.Flux<org.springframework.util.MultiValueMap<String,String>>	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<org.springframework.util.MultiValueMap<String,String>>	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.
void	setDefaultCharset(Charset charset) Set the default character set to use for reading form data when the request Content-Type header does not explicitly specify it.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

Constructor Detail

FormHttpMessageReader

public FormHttpMessageReader()

Method Detail

setDefaultCharset

public void setDefaultCharset(Charset charset)

Set the default character set to use for reading form data when the request Content-Type header does not explicitly specify it.

By default this is set to "UTF-8".

getDefaultCharset

public Charset getDefaultCharset()

Return the configured default charset.

canRead

public boolean canRead(org.springframework.core.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<org.springframework.util.MultiValueMap<String,String>>

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 reactor.core.publisher.Flux<org.springframework.util.MultiValueMap<String,String>> read(org.springframework.core.ResolvableType elementType,
                                                                                               ReactiveHttpInputMessage inputMessage,
                                                                                               Map<String,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<org.springframework.util.MultiValueMap<String,String>>

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 reactor.core.publisher.Mono<org.springframework.util.MultiValueMap<String,String>> readMono(org.springframework.core.ResolvableType elementType,
                                                                                                   ReactiveHttpInputMessage inputMessage,
                                                                                                   Map<String,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<org.springframework.util.MultiValueMap<String,String>>

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 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<org.springframework.util.MultiValueMap<String,String>>

Returns:

the list of supported readable media types