Class CompletedFileUpload

java.lang.Object

io.micronaut.http.multipart.CompletedPart

io.micronaut.http.multipart.CompletedFileUpload

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract sealed class CompletedFileUpload
extends CompletedPart

Represents a completed part of a multipart request. May be backed by a file or memory depending on server configuration.

When used as an argument to an Controller instance method, the route is not executed until the part has been fully received. Provides access to metadata about the file as well as the contents.

This object is closed when the request terminates. If you wish to use the data for longer, you need to call one of the consumption methods before that happens.

Since:

1.0.0

Author:

Zachary Klein

Method Summary

Modifier and Type	Method	Description
final Optional<MediaType>	getContentType()	Get the content type of the file, if specified.
final String	getFilename()	Get the file name provided by the user.
abstract CompletedFileUpload	moveResource()	The completed part objects passed to a controller are closed when the associated request ends.
static CompletedFileUpload	ofFile(FormFieldMetadata metadata, TemporaryFileResource path, long size)	Create a new file-backed file upload.
static CompletedFileUpload	ofMemory(FormFieldMetadata metadata, ReadBuffer memory)	Create a new memory-backed file upload.
abstract void	transferTo(Path destination)	Transfer this upload to the given file.

Methods inherited from class CompletedPart

closeAsync, getBytes, getInputStream, getMetadata, getName, getSize, isInMemory, toReadBuffer

Methods inherited from class Object

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

Methods inherited from interface Closeable

close

Method Details

moveResource

public abstract CompletedFileUpload moveResource()

Description copied from class: CompletedPart

The completed part objects passed to a controller are closed when the associated request ends. If you want to keep them around for longer, you can use this method to create a new CompletedPart with the same data. You are responsible for closing the new part.

Specified by:

moveResource in class CompletedPart

Returns:

A new completed part

ofMemory

public static CompletedFileUpload ofMemory(FormFieldMetadata metadata,
 ReadBuffer memory)

Create a new memory-backed file upload. Ownership of the data buffer transfers to the file upload object. Closing the file upload object will close the memory.

Parameters:

metadata - The field metadata

memory - The field data

Returns:

The file upload structure

ofFile

public static CompletedFileUpload ofFile(FormFieldMetadata metadata,
 TemporaryFileResource path,
 long size)

Create a new file-backed file upload. Ownership of the file transfers to the file upload object. Closing the file upload object will delete the backing file.

Parameters:

metadata - The field metadata

path - The backing file

size - The size of the backing file

Returns:

The file upload structure

getContentType

public final Optional<MediaType> getContentType()

Get the content type of the file, if specified.

Returns:

The content type

See Also:

• FormFieldMetadata.mediaType()

getFilename

public final String getFilename()

Get the file name provided by the user.

Returns:

The file name

See Also:

• FormFieldMetadata.fileName()

transferTo

public abstract void transferTo(Path destination)
                         throws IOException

Transfer this upload to the given file. This operation closes this CompletedFileUpload. No further operations may be performed.

Parameters:

destination - The target file

Throws:

IOException