io.micronaut.objectstorage.request

Class CompletedFileUploadRequest

java.lang.Object

io.micronaut.objectstorage.request.CompletedFileUploadRequest

All Implemented Interfaces:

UploadRequest

public class CompletedFileUploadRequest
extends java.lang.Object
implements UploadRequest

An UploadRequest backed by a CompletedFileUpload.

Since:

1.0

Author:

Álvaro Sánchez-Mariscal

Constructor Summary

Constructors

Constructor and Description
CompletedFileUploadRequest(io.micronaut.http.multipart.CompletedFileUpload completedFileUpload)
CompletedFileUploadRequest(io.micronaut.http.multipart.CompletedFileUpload completedFileUpload, java.lang.String key)
CompletedFileUploadRequest(io.micronaut.http.multipart.CompletedFileUpload completedFileUpload, java.lang.String key, java.util.Map<java.lang.String,java.lang.String> metadata)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.Long>	getContentSize()
java.util.Optional<java.lang.String>	getContentType()
java.io.InputStream	getInputStream()
java.lang.String	getKey()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.objectstorage.request.UploadRequest

fromBytes, fromBytes, fromCompletedFileUpload, fromCompletedFileUpload, fromPath, fromPath, setContentType

Constructor Detail

CompletedFileUploadRequest

public CompletedFileUploadRequest(@NonNull
                                  io.micronaut.http.multipart.CompletedFileUpload completedFileUpload)

CompletedFileUploadRequest

public CompletedFileUploadRequest(@NonNull
                                  io.micronaut.http.multipart.CompletedFileUpload completedFileUpload,
                                  @NonNull
                                  java.lang.String key)

CompletedFileUploadRequest

public CompletedFileUploadRequest(@NonNull
                                  io.micronaut.http.multipart.CompletedFileUpload completedFileUpload,
                                  @NonNull
                                  java.lang.String key,
                                  @NonNull
                                  java.util.Map<java.lang.String,java.lang.String> metadata)

Method Detail

getContentType

@NonNull
public java.util.Optional<java.lang.String> getContentType()

Specified by:

getContentType in interface UploadRequest

Returns:

the content type of this upload request.

getKey

@NonNull
public java.lang.String getKey()

Specified by:

getKey in interface UploadRequest

Returns:

the file name with path.

getContentSize

@NonNull
public java.util.Optional<java.lang.Long> getContentSize()

Specified by:

getContentSize in interface UploadRequest

Returns:

the size of the file, in bytes.

getInputStream

@NonNull
public java.io.InputStream getInputStream()

Specified by:

getInputStream in interface UploadRequest

Returns:

an input stream of the object to be stored.

getMetadata

@NonNull
public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Specified by:

getMetadata in interface UploadRequest

Returns:

a map with key-value pairs to be stored along the file. An empty map by default.

setMetadata

public void setMetadata(@NonNull
                        java.util.Map<java.lang.String,java.lang.String> metadata)

Specified by:

setMetadata in interface UploadRequest

Parameters:

metadata - a map with key-value pairs to be stored along the file.