org.springframework.http.codec

Class FormHttpMessageWriter

java.lang.Object

org.springframework.http.codec.FormHttpMessageWriter

All Implemented Interfaces:

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

public class FormHttpMessageWriter
extends Object
implements HttpMessageWriter<org.springframework.util.MultiValueMap<String,String>>

Implementation of an HttpMessageWriter to write HTML form data, i.e. response 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
FormHttpMessageWriter()

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(org.springframework.core.ResolvableType elementType, MediaType mediaType) Indicates whether the given class can be written by this converter.
Charset	getDefaultCharset() Return the configured default charset.
List<MediaType>	getWritableMediaTypes() Return the list of MediaType objects that can be written by this converter.
void	setDefaultCharset(Charset charset) Set the default character set to use for writing form data when the response Content-Type header does not explicitly specify it.
reactor.core.publisher.Mono<Void>	write(org.reactivestreams.Publisher<? extends org.springframework.util.MultiValueMap<String,String>> inputStream, org.springframework.core.ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, Map<String,Object> hints) Write an given object to the given output message.

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

FormHttpMessageWriter

public FormHttpMessageWriter()

Method Detail

setDefaultCharset

public void setDefaultCharset(Charset charset)

Set the default character set to use for writing form data when the response 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.

canWrite

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

Description copied from interface: HttpMessageWriter

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

Specified by:

canWrite in interface HttpMessageWriter<org.springframework.util.MultiValueMap<String,String>>

Parameters:

elementType - the stream element type to test for writability

mediaType - the media type to write, can be null if not specified. Typically the value of an Accept header.

Returns:

true if writable; false otherwise

write

public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<? extends org.springframework.util.MultiValueMap<String,String>> inputStream,
                                               org.springframework.core.ResolvableType elementType,
                                               MediaType mediaType,
                                               ReactiveHttpOutputMessage outputMessage,
                                               Map<String,Object> hints)

Description copied from interface: HttpMessageWriter

Write an given object to the given output message.

Specified by:

write in interface HttpMessageWriter<org.springframework.util.MultiValueMap<String,String>>

Parameters:

inputStream - the input stream to write

elementType - the stream element type to process. This type must have previously been passed to the HttpMessageWriter.canWrite(org.springframework.core.ResolvableType, org.springframework.http.MediaType) canWrite} method of this interface, which must have returned true.

mediaType - the content type to use when writing, typically the value of an Accept header. May be null to indicate that the default content type of the converter must be used.

outputMessage - the message to write to

hints - additional information about how to write

Returns:

a Mono that indicates completion or error

getWritableMediaTypes

public List<MediaType> getWritableMediaTypes()

Description copied from interface: HttpMessageWriter

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

Specified by:

getWritableMediaTypes in interface HttpMessageWriter<org.springframework.util.MultiValueMap<String,String>>

Returns:

the list of supported readable media types