org.springframework.http.codec.multipart

Class MultipartHttpMessageReader

java.lang.Object

org.springframework.http.codec.multipart.MultipartHttpMessageReader

All Implemented Interfaces:

HttpMessageReader<MultiValueMap<java.lang.String,Part>>

public class MultipartHttpMessageReader
extends java.lang.Object
implements HttpMessageReader<MultiValueMap<java.lang.String,Part>>

HttpMessageReader for reading "multipart/form-data" requests into a MultiValueMap<String, Part>.

Note that this reader depends on access to an HttpMessageReader<Part> for the actual parsing of multipart content. The purpose of this reader is to collect the parts into a map.

Since:

5.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
MultipartHttpMessageReader(HttpMessageReader<Part> partReader)

Method Summary

Modifier and Type	Method and Description
boolean	canRead(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this reader.
java.util.List<MediaType>	getReadableMediaTypes() Return the MediaType's that this reader supports.
reactor.core.publisher.Flux<MultiValueMap<java.lang.String,Part>>	read(ResolvableType elementType, ReactiveHttpInputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Read from the input message and encode to a stream of objects.
reactor.core.publisher.Mono<MultiValueMap<java.lang.String,Part>>	readMono(ResolvableType elementType, ReactiveHttpInputMessage inputMessage, java.util.Map<java.lang.String,java.lang.Object> hints) Read from the input message and encode to a single object.

Methods inherited from class java.lang.Object

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

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

read, readMono

Constructor Detail

MultipartHttpMessageReader

public MultipartHttpMessageReader(HttpMessageReader<Part> partReader)

Method Detail

getReadableMediaTypes

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

Description copied from interface: HttpMessageReader

Return the MediaType's that this reader supports.

Specified by:

getReadableMediaTypes in interface HttpMessageReader<MultiValueMap<java.lang.String,Part>>

canRead

public boolean canRead(ResolvableType elementType,
                       @Nullable
                       MediaType mediaType)

Description copied from interface: HttpMessageReader

Whether the given object type is supported by this reader.

Specified by:

canRead in interface HttpMessageReader<MultiValueMap<java.lang.String,Part>>

Parameters:

elementType - the type of object to check

mediaType - the media type for the read (possibly null)

Returns:

true if readable, false otherwise

read

public reactor.core.publisher.Flux<MultiValueMap<java.lang.String,Part>> read(ResolvableType elementType,
                                                                              ReactiveHttpInputMessage message,
                                                                              java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageReader

Read from the input message and encode to a stream of objects.

Specified by:

read in interface HttpMessageReader<MultiValueMap<java.lang.String,Part>>

Parameters:

elementType - the type of objects in the stream which must have been previously checked via HttpMessageReader.canRead(ResolvableType, MediaType)

message - the message to read from

hints - additional information about how to read and decode the input

Returns:

the decoded stream of elements

readMono

public reactor.core.publisher.Mono<MultiValueMap<java.lang.String,Part>> readMono(ResolvableType elementType,
                                                                                  ReactiveHttpInputMessage inputMessage,
                                                                                  java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageReader

Read from the input message and encode to a single object.

Specified by:

readMono in interface HttpMessageReader<MultiValueMap<java.lang.String,Part>>

Parameters:

elementType - the type of objects in the stream which must have been previously checked via HttpMessageReader.canRead(ResolvableType, MediaType)

inputMessage - the message to read from

hints - additional information about how to read and decode the input

Returns:

the decoded object