org.springframework.http.codec.multipart

Class SynchronossPartHttpMessageReader

java.lang.Object

org.springframework.http.codec.LoggingCodecSupport

org.springframework.http.codec.multipart.SynchronossPartHttpMessageReader

All Implemented Interfaces:

HttpMessageReader<Part>

public class SynchronossPartHttpMessageReader
extends LoggingCodecSupport
implements HttpMessageReader<Part>

HttpMessageReader for parsing "multipart/form-data" requests to a stream of Part's using the Synchronoss NIO Multipart library.

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

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev, Arjen Poutsma, Brian Clozel

See Also:

Synchronoss NIO Multipart, MultipartHttpMessageReader

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
SynchronossPartHttpMessageReader()

Method Summary

Modifier and Type	Method and Description
boolean	canRead(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this reader.
long	getMaxDiskUsagePerPart() Get the configured maximum disk usage.
int	getMaxInMemorySize() Get the configured maximum in-memory size.
int	getMaxParts() Return the configured limit on the number of parts.
List<MediaType>	getReadableMediaTypes() Return the list of media types supported by this reader.
reactor.core.publisher.Flux<Part>	read(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String,Object> hints) Read from the input message and decode to a stream of objects.
reactor.core.publisher.Mono<Part>	readMono(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String,Object> hints) Read from the input message and decode to a single object.
void	setFileStorageDirectory(Path fileStorageDirectory) Set the directory used to store parts larger than maxInMemorySize.
void	setMaxDiskUsagePerPart(long maxDiskUsagePerPart) Configure the maximum amount of disk space allowed for file parts.
void	setMaxInMemorySize(int byteCount) Configure the maximum amount of memory that is allowed to use per part.
void	setMaxParts(int maxParts) Specify the maximum number of parts allowed in a given multipart request.

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

getReadableMediaTypes, read, readMono

Constructor Detail

SynchronossPartHttpMessageReader

public SynchronossPartHttpMessageReader()

Method Detail

setMaxInMemorySize

public void setMaxInMemorySize(int byteCount)

Configure the maximum amount of memory that is allowed to use per part. When the limit is exceeded:

• file parts are written to a temporary file.
• non-file parts are rejected with DataBufferLimitException.

By default this is set to 256K.

Parameters:

byteCount - the in-memory limit in bytes; if set to -1 this limit is not enforced, and all parts may be written to disk and are limited only by the maxDiskUsagePerPart property.

Since:

5.1.11

getMaxInMemorySize

public int getMaxInMemorySize()

Get the configured maximum in-memory size.

Since:

5.1.11

setMaxDiskUsagePerPart

public void setMaxDiskUsagePerPart(long maxDiskUsagePerPart)

Configure the maximum amount of disk space allowed for file parts.

By default this is set to -1.

Parameters:

maxDiskUsagePerPart - the disk limit in bytes, or -1 for unlimited

Since:

5.1.11

getMaxDiskUsagePerPart

public long getMaxDiskUsagePerPart()

Get the configured maximum disk usage.

Since:

5.1.11

setMaxParts

public void setMaxParts(int maxParts)

Specify the maximum number of parts allowed in a given multipart request.

Since:

5.1.11

getMaxParts

public int getMaxParts()

Return the configured limit on the number of parts.

Since:

5.1.11

setFileStorageDirectory

public void setFileStorageDirectory(Path fileStorageDirectory)
                             throws IOException

Set the directory used to store parts larger than maxInMemorySize. By default, a new temporary directory is created.

Throws:

IOException - if an I/O error occurs, or the parent directory does not exist

Since:

5.3.7

getReadableMediaTypes

public List<MediaType> getReadableMediaTypes()

Description copied from interface: HttpMessageReader

Return the list of media types supported by this reader. The list may not apply to every possible target element type and calls to this method should typically be guarded via canWrite(elementType, null). The list may also exclude media types supported only for a specific element type. Alternatively, use HttpMessageReader.getReadableMediaTypes(ResolvableType) for a more precise list.

Specified by:

getReadableMediaTypes in interface HttpMessageReader<Part>

Returns:

the general list of supported media types

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<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(ResolvableType elementType,
                                              ReactiveHttpInputMessage message,
                                              Map<String,Object> hints)

Description copied from interface: HttpMessageReader

Read from the input message and decode 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(ResolvableType elementType,
                                                  ReactiveHttpInputMessage message,
                                                  Map<String,Object> hints)

Description copied from interface: HttpMessageReader

Read from the input message and decode 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