org.springframework.http.codec.multipart

Class DefaultMultipartMessageReader

java.lang.Object

org.springframework.http.codec.LoggingCodecSupport

org.springframework.http.codec.multipart.DefaultMultipartMessageReader

All Implemented Interfaces:

HttpMessageReader<Part>

public class DefaultMultipartMessageReader
extends LoggingCodecSupport
implements HttpMessageReader<Part>

HttpMessageReader for parsing "multipart/form-data" requests to a stream of Part's.

This reader can be provided to MultipartHttpMessageReader in order to aggregate all parts into a Map.

Since:

5.2

Author:

Arjen Poutsma

See Also:

MultipartHttpMessageReader

Constructor Summary

Constructors

Constructor and Description
DefaultMultipartMessageReader()

Method Summary

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

Methods inherited from class org.springframework.http.codec.LoggingCodecSupport

isEnableLoggingRequestDetails, setEnableLoggingRequestDetails

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

DefaultMultipartMessageReader

public DefaultMultipartMessageReader()

Method Detail

getReadableMediaTypes

public List<MediaType> getReadableMediaTypes()

Description copied from interface: HttpMessageReader

Return the MediaType's that this reader supports.

Specified by:

getReadableMediaTypes in interface HttpMessageReader<Part>

canRead

public boolean canRead(org.springframework.core.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<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<Part> read(org.springframework.core.ResolvableType elementType,
                                              ReactiveHttpInputMessage message,
                                              Map<String,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<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<Part> readMono(org.springframework.core.ResolvableType elementType,
                                                  ReactiveHttpInputMessage message,
                                                  Map<String,Object> hints)

Description copied from interface: HttpMessageReader

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

Specified by:

readMono in interface HttpMessageReader<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 object