org.springframework.http.codec.multipart

Class MultipartHttpMessageWriter

java.lang.Object

org.springframework.http.codec.LoggingCodecSupport

org.springframework.http.codec.multipart.MultipartHttpMessageWriter

All Implemented Interfaces:

HttpMessageWriter<MultiValueMap<java.lang.String,?>>

public class MultipartHttpMessageWriter
extends LoggingCodecSupport
implements HttpMessageWriter<MultiValueMap<java.lang.String,?>>

HttpMessageWriter for writing a MultiValueMap<String, ?> as multipart form data, i.e. "multipart/form-data", to the body of a request.

The serialization of individual parts is delegated to other writers. By default only String and Resource parts are supported but you can configure others through a constructor argument.

This writer can be configured with a FormHttpMessageWriter to delegate to. It is the preferred way of supporting both form data and multipart data (as opposed to registering each writer separately) so that when the MediaType is not specified and generics are not present on the target element type, we can inspect the values in the actual map and decide whether to write plain form data (String values only) or otherwise.

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

See Also:

FormHttpMessageWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MultipartHttpMessageWriter.MultipartHttpOutputMessage

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.charset.Charset	charset
static java.nio.charset.Charset	DEFAULT_CHARSET THe default charset used by the writer.
private static java.util.Map<java.lang.String,java.lang.Object>	DEFAULT_HINTS Suppress logging from individual part writers (full map logged at this level).
private HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>>	formWriter
private java.util.List<HttpMessageWriter<?>>	partWriters
private java.util.List<MediaType>	supportedMediaTypes

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

logger

Constructor Summary

Constructors

Constructor and Description
MultipartHttpMessageWriter() Constructor with a default list of part writers (String and Resource).
MultipartHttpMessageWriter(java.util.List<HttpMessageWriter<?>> partWriters) Constructor with explicit list of writers for serializing parts.
MultipartHttpMessageWriter(java.util.List<HttpMessageWriter<?>> partWriters, HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>> formWriter) Constructor with explicit list of writers for serializing parts and a writer for plain form data to fall back when no media type is specified and the actual map consists of String values only.

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this writer.
private <T> <any>	encodePart(byte[] boundary, java.lang.String name, T value, DataBufferFactory bufferFactory)
private <any>	encodePartValues(byte[] boundary, java.lang.String name, java.util.List<?> values, DataBufferFactory bufferFactory)
private <any>	generateBoundaryLine(byte[] boundary, DataBufferFactory bufferFactory)
private <any>	generateLastLine(byte[] boundary, DataBufferFactory bufferFactory)
protected byte[]	generateMultipartBoundary() Generate a multipart boundary.
private <any>	generateNewLine(DataBufferFactory bufferFactory)
java.nio.charset.Charset	getCharset() Return the configured charset for part headers.
java.util.List<HttpMessageWriter<?>>	getPartWriters() Return the configured part writers.
java.util.List<MediaType>	getWritableMediaTypes() Return the MediaType's that this writer supports.
private static java.util.List<MediaType>	initMediaTypes(HttpMessageWriter<?> formWriter)
private boolean	isMultipart(MultiValueMap<java.lang.String,?> map, MediaType contentType)
void	setCharset(java.nio.charset.Charset charset) Set the character set to use for part headers such as "Content-Disposition" (and its filename parameter).
<any>	write(<any> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, java.util.Map<java.lang.String,java.lang.Object> hints) Write an given stream of object to the output message.
private <any>	writeMultipart(MultiValueMap<java.lang.String,?> map, ReactiveHttpOutputMessage outputMessage, java.util.Map<java.lang.String,java.lang.Object> hints)

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.HttpMessageWriter

write

Field Detail

DEFAULT_CHARSET

public static final java.nio.charset.Charset DEFAULT_CHARSET

THe default charset used by the writer.

DEFAULT_HINTS

private static final java.util.Map<java.lang.String,java.lang.Object> DEFAULT_HINTS

Suppress logging from individual part writers (full map logged at this level).

partWriters

private final java.util.List<HttpMessageWriter<?>> partWriters

formWriter

@Nullable
private final HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>> formWriter

charset

private java.nio.charset.Charset charset

supportedMediaTypes

private final java.util.List<MediaType> supportedMediaTypes

Constructor Detail

MultipartHttpMessageWriter

public MultipartHttpMessageWriter()

Constructor with a default list of part writers (String and Resource).

MultipartHttpMessageWriter

public MultipartHttpMessageWriter(java.util.List<HttpMessageWriter<?>> partWriters)

Constructor with explicit list of writers for serializing parts.

MultipartHttpMessageWriter

public MultipartHttpMessageWriter(java.util.List<HttpMessageWriter<?>> partWriters,
                                  @Nullable
                                  HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>> formWriter)

Constructor with explicit list of writers for serializing parts and a writer for plain form data to fall back when no media type is specified and the actual map consists of String values only.

Parameters:

partWriters - the writers for serializing parts

formWriter - the fallback writer for form data, null by default

Method Detail

initMediaTypes

private static java.util.List<MediaType> initMediaTypes(@Nullable
                                                        HttpMessageWriter<?> formWriter)

getPartWriters

public java.util.List<HttpMessageWriter<?>> getPartWriters()

Return the configured part writers.

Since:

5.0.7

setCharset

public void setCharset(java.nio.charset.Charset charset)

Set the character set to use for part headers such as "Content-Disposition" (and its filename parameter).

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

getCharset

public java.nio.charset.Charset getCharset()

Return the configured charset for part headers.

getWritableMediaTypes

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

Description copied from interface: HttpMessageWriter

Return the MediaType's that this writer supports.

Specified by:

getWritableMediaTypes in interface HttpMessageWriter<MultiValueMap<java.lang.String,?>>

canWrite

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

Description copied from interface: HttpMessageWriter

Whether the given object type is supported by this writer.

Specified by:

canWrite in interface HttpMessageWriter<MultiValueMap<java.lang.String,?>>

Parameters:

elementType - the type of object to check

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

Returns:

true if writable, false otherwise

write

public <any> write(<any> inputStream,
                   ResolvableType elementType,
                   @Nullable
                   MediaType mediaType,
                   ReactiveHttpOutputMessage outputMessage,
                   java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageWriter

Write an given stream of object to the output message.

Specified by:

write in interface HttpMessageWriter<MultiValueMap<java.lang.String,?>>

Parameters:

inputStream - the objects to write

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

mediaType - the content type for the write (possibly null to indicate that the default content type of the writer must be used)

outputMessage - the message to write to

hints - additional information about how to encode and write

Returns:

indicates completion or error

isMultipart

private boolean isMultipart(MultiValueMap<java.lang.String,?> map,
                            @Nullable
                            MediaType contentType)

writeMultipart

private <any> writeMultipart(MultiValueMap<java.lang.String,?> map,
                             ReactiveHttpOutputMessage outputMessage,
                             java.util.Map<java.lang.String,java.lang.Object> hints)

generateMultipartBoundary

protected byte[] generateMultipartBoundary()

Generate a multipart boundary.

By default delegates to MimeTypeUtils.generateMultipartBoundary().

encodePartValues

private <any> encodePartValues(byte[] boundary,
                               java.lang.String name,
                               java.util.List<?> values,
                               DataBufferFactory bufferFactory)

encodePart

private <T> <any> encodePart(byte[] boundary,
                             java.lang.String name,
                             T value,
                             DataBufferFactory bufferFactory)

generateBoundaryLine

private <any> generateBoundaryLine(byte[] boundary,
                                   DataBufferFactory bufferFactory)

generateNewLine

private <any> generateNewLine(DataBufferFactory bufferFactory)

generateLastLine

private <any> generateLastLine(byte[] boundary,
                               DataBufferFactory bufferFactory)