Class FormFactory

java.lang.Object

io.micronaut.http.server.multipart.FormFactory

@Internal
@Singleton
public final class FormFactory
extends Object

Global utility class for form data access.

Since:

5.0.0

Author:

Jonas Konrad

Method Summary

Modifier and Type	Method	Description
ExecutionFlow<CompletedAttribute>	completeAttribute(FormCapableHttpRequest<?> request, RawFormField formField)	Asynchronously buffer the given attribute.
ExecutionFlow<CompletedFileUpload>	completeFileUpload(FormCapableHttpRequest<?> request, RawFormField formField)	Buffer a streamed RawFormField into a CompletedFileUpload.
ExecutionFlow<? extends CompletedPart>	completePart(FormCapableHttpRequest<?> request, RawFormField formField)	Asynchronously buffer the given field.
static @Nullable FormRouteCompleter	getCompleterOrNull(HttpRequest<?> request)	Get the completer for the given request, if it has been created by getOrCreateCompleter(HttpRequest).
Executor	getDiskWriteExecutor()
FormRouteCompleter	getOrCreateCompleter(HttpRequest<?> request)	Create the completer for the given request if necessary.
StreamingFileUpload	streamFileUpload(RawFormField formField)	Create a new StreamingFileUpload from the given raw data.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getDiskWriteExecutor

public Executor getDiskWriteExecutor()

getCompleterOrNull

@Nullable
public static @Nullable FormRouteCompleter getCompleterOrNull(HttpRequest<?> request)

Get the completer for the given request, if it has been created by getOrCreateCompleter(HttpRequest).

Parameters:

request - The request

Returns:

The completer

getOrCreateCompleter

public FormRouteCompleter getOrCreateCompleter(HttpRequest<?> request)

Create the completer for the given request if necessary.

Parameters:

request - The request

Returns:

The completer

completePart

public ExecutionFlow<? extends CompletedPart> completePart(FormCapableHttpRequest<?> request,
 RawFormField formField)

Asynchronously buffer the given field. If the field is determined to be a file upload, data may be buffered to disk.

Parameters:

request - The request this field came in on

formField - The field

Returns:

A flow that completes when the full field has been buffered

completeAttribute

public ExecutionFlow<CompletedAttribute> completeAttribute(FormCapableHttpRequest<?> request,
 RawFormField formField)

Asynchronously buffer the given attribute.

Parameters:

request - The request this field came in on

formField - The field

Returns:

A flow that completes when the full field has been buffered

completeFileUpload

public ExecutionFlow<CompletedFileUpload> completeFileUpload(FormCapableHttpRequest<?> request,
 RawFormField formField)

Buffer a streamed RawFormField into a CompletedFileUpload. May save data to disk, if configured.

Parameters:

request - Optional request, used to get at the ReadBufferFactory

formField - The form field to stream

Returns:

The flow with the uploaded file

streamFileUpload

public StreamingFileUpload streamFileUpload(RawFormField formField)

Create a new StreamingFileUpload from the given raw data.

Parameters:

formField - The field

Returns:

The streaming upload