Package reactor.netty.http.server

Interface HttpServerFormDecoderProvider.Builder

Enclosing class:

HttpServerFormDecoderProvider

public static interface HttpServerFormDecoderProvider.Builder

Method Summary

Modifier and Type	Method	Description
HttpServerFormDecoderProvider.Builder	baseDirectory(Path baseDirectory)	Sets the directory where to store disk Attribute/FileUpload.
HttpServerFormDecoderProvider.Builder	charset(Charset charset)	Set the Charset for Attribute/FileUpload.
HttpServerFormDecoderProvider.Builder	maxInMemorySize(long maxInMemorySize)	Sets the maximum in-memory size per Attribute/FileUpload i.e.
HttpServerFormDecoderProvider.Builder	maxSize(long maxSize)	Set the maximum size per Attribute/FileUpload.
HttpServerFormDecoderProvider.Builder	scheduler(Scheduler scheduler)	Sets the scheduler to be used for offloading disk operations in the decoding phase.
HttpServerFormDecoderProvider.Builder	streaming(boolean enable)	When set to true, the data is streamed directly from the parsed input buffer stream, which means it is not stored either in memory or file.

Method Details

baseDirectory

HttpServerFormDecoderProvider.Builder baseDirectory(Path baseDirectory)

Sets the directory where to store disk Attribute/FileUpload. Default to generated temp directory.

Parameters:

baseDirectory - directory where to store disk Attribute/FileUpload

Returns:

this

charset

HttpServerFormDecoderProvider.Builder charset(Charset charset)

Set the Charset for Attribute/FileUpload. Default to StandardCharsets.UTF_8.

Parameters:

charset - the charset for Attribute/FileUpload

Returns:

this

maxInMemorySize

HttpServerFormDecoderProvider.Builder maxInMemorySize(long maxInMemorySize)

Sets the maximum in-memory size per Attribute/FileUpload i.e. the data is written on disk if the size is greater than maxInMemorySize, else it is in memory. Default to DefaultHttpDataFactory.MINSIZE.

Note:

• If set to -1 the entire contents is stored in memory
• If set to 0 the entire contents is stored on disk

Parameters:

maxInMemorySize - the maximum in-memory size

Returns:

this

maxSize

HttpServerFormDecoderProvider.Builder maxSize(long maxSize)

Set the maximum size per Attribute/FileUpload. When the limit is reached, an exception is raised. Default to DefaultHttpDataFactory.MAXSIZE - unlimited.

Note: If set to -1 this means no limitation.

Parameters:

maxSize - the maximum size allowed for an individual attribute/fileUpload

Returns:

this

scheduler

HttpServerFormDecoderProvider.Builder scheduler(Scheduler scheduler)

Sets the scheduler to be used for offloading disk operations in the decoding phase. Default to Schedulers.boundedElastic()

Parameters:

scheduler - the scheduler to be used for offloading disk operations in the decoding phase

Returns:

this

streaming

HttpServerFormDecoderProvider.Builder streaming(boolean enable)

When set to true, the data is streamed directly from the parsed input buffer stream, which means it is not stored either in memory or file. When false, parts are backed by in-memory and/or file storage. Default to false.

NOTE that with streaming enabled, the provided Attribute/FileUpload might not be in a complete state i.e. HttpData.isCompleted() has to be checked.

Also note that enabling this property effectively ignores maxInMemorySize(long), baseDirectory(Path), and scheduler(Scheduler).