org.springframework.http.codec.multipart

Class MultipartWriterSupport

java.lang.Object

org.springframework.http.codec.LoggingCodecSupport

org.springframework.http.codec.multipart.MultipartWriterSupport

Direct Known Subclasses:

MultipartHttpMessageWriter, PartHttpMessageWriter

public class MultipartWriterSupport
extends LoggingCodecSupport

Support class for multipart HTTP message writers.

Since:

5.3

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET THe default charset used by the writer.

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

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultipartWriterSupport(List<MediaType> supportedMediaTypes) Constructor with the list of supported media types.

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(ResolvableType elementType, MediaType mediaType)
protected reactor.core.publisher.Mono<DataBuffer>	generateBoundaryLine(byte[] boundary, DataBufferFactory bufferFactory)
protected reactor.core.publisher.Mono<DataBuffer>	generateLastLine(byte[] boundary, DataBufferFactory bufferFactory)
protected byte[]	generateMultipartBoundary() Generate a multipart boundary.
protected reactor.core.publisher.Mono<DataBuffer>	generateNewLine(DataBufferFactory bufferFactory)
protected reactor.core.publisher.Mono<DataBuffer>	generatePartHeaders(HttpHeaders headers, DataBufferFactory bufferFactory)
Charset	getCharset() Return the configured charset for part headers.
protected MediaType	getMultipartMediaType(MediaType mediaType, byte[] boundary) Prepare the MediaType to use by adding "boundary" and "charset" parameters to the given mediaType or "mulitpart/form-data" otherwise by default.
List<MediaType>	getWritableMediaTypes()
void	setCharset(Charset charset) Set the character set to use for part headers such as "Content-Disposition" (and its filename parameter).

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

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

THe default charset used by the writer.

Constructor Detail

MultipartWriterSupport

protected MultipartWriterSupport(List<MediaType> supportedMediaTypes)

Constructor with the list of supported media types.

Method Detail

getCharset

public Charset getCharset()

Return the configured charset for part headers.

setCharset

public void setCharset(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". If changed from this default, the "Content-Type" header will have a "charset" parameter that specifies the character set used.

getWritableMediaTypes

public List<MediaType> getWritableMediaTypes()

canWrite

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

generateMultipartBoundary

protected byte[] generateMultipartBoundary()

Generate a multipart boundary.

By default delegates to MimeTypeUtils.generateMultipartBoundary().

getMultipartMediaType

protected MediaType getMultipartMediaType(@Nullable
                                          MediaType mediaType,
                                          byte[] boundary)

Prepare the MediaType to use by adding "boundary" and "charset" parameters to the given mediaType or "mulitpart/form-data" otherwise by default.

generateBoundaryLine

protected reactor.core.publisher.Mono<DataBuffer> generateBoundaryLine(byte[] boundary,
                                                                       DataBufferFactory bufferFactory)

generateNewLine

protected reactor.core.publisher.Mono<DataBuffer> generateNewLine(DataBufferFactory bufferFactory)

generateLastLine

protected reactor.core.publisher.Mono<DataBuffer> generateLastLine(byte[] boundary,
                                                                   DataBufferFactory bufferFactory)

generatePartHeaders

protected reactor.core.publisher.Mono<DataBuffer> generatePartHeaders(HttpHeaders headers,
                                                                      DataBufferFactory bufferFactory)