io.micronaut.objectstorage.request

Interface UploadRequest

All Known Implementing Classes:

AbstractUploadRequest, BytesUploadRequest, CompletedFileUploadRequest, FileUploadRequest

public interface UploadRequest

Object storage upload request.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static UploadRequest	fromBytes(byte[] bytes, java.lang.String key)
static UploadRequest	fromBytes(byte[] bytes, java.lang.String key, java.lang.String contentType)
static UploadRequest	fromCompletedFileUpload(io.micronaut.http.multipart.CompletedFileUpload completedFileUpload)
static UploadRequest	fromCompletedFileUpload(io.micronaut.http.multipart.CompletedFileUpload completedFileUpload, java.lang.String key)
static UploadRequest	fromPath(java.nio.file.Path path)
static UploadRequest	fromPath(java.nio.file.Path path, java.lang.String prefix)
java.util.Optional<java.lang.Long>	getContentSize()
java.util.Optional<java.lang.String>	getContentType()
java.io.InputStream	getInputStream()
java.lang.String	getKey()
default java.util.Map<java.lang.String,java.lang.String>	getMetadata()
default void	setContentType(java.lang.String contentType)
default void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Method Detail

fromPath

@NonNull
static UploadRequest fromPath(@NonNull
                                       java.nio.file.Path path)

Parameters:

path - the path to the file.

Returns:

An UploadRequest from the given path.

fromPath

@NonNull
static UploadRequest fromPath(@NonNull
                                       java.nio.file.Path path,
                                       @NonNull
                                       java.lang.String prefix)

Parameters:

path - the path to the file.

prefix - the prefix under which the file will be stored (prefix/fileName).

Returns:

An UploadRequest from the given path and prefix

fromBytes

@NonNull
static UploadRequest fromBytes(@NonNull
                                        byte[] bytes,
                                        @NonNull
                                        java.lang.String key)

Parameters:

bytes - the source byte array.

key - the key under which the file will be stored (path/to/file)

Returns:

An UploadRequest from the given byte array and key

fromBytes

@NonNull
static UploadRequest fromBytes(@NonNull
                                        byte[] bytes,
                                        @NonNull
                                        java.lang.String key,
                                        @NonNull
                                        java.lang.String contentType)

Parameters:

bytes - the source byte array.

key - the key under which the file will be stored (path/to/file)

contentType - the content type of the file to store.

Returns:

An UploadRequest from the given parameters.

fromCompletedFileUpload

@NonNull
static UploadRequest fromCompletedFileUpload(@NonNull
                                                      io.micronaut.http.multipart.CompletedFileUpload completedFileUpload)

Parameters:

completedFileUpload - the CompletedFileUpload.

Returns:

An UploadRequest from the given CompletedFileUpload.

fromCompletedFileUpload

@NonNull
static UploadRequest fromCompletedFileUpload(@NonNull
                                                      io.micronaut.http.multipart.CompletedFileUpload completedFileUpload,
                                                      @NonNull
                                                      java.lang.String key)

Parameters:

completedFileUpload - the CompletedFileUpload.

key - the key under which the file will be stored (path/to/file)

Returns:

An UploadRequest from the given CompletedFileUpload and key.

getContentType

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

Returns:

the content type of this upload request.

getKey

@NonNull
java.lang.String getKey()

Returns:

the file name with path.

getContentSize

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

Returns:

the size of the file, in bytes.

getInputStream

@NonNull
java.io.InputStream getInputStream()

Returns:

an input stream of the object to be stored.

getMetadata

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

Returns:

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

Since:

1.1.0

setMetadata

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

Parameters:

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

Since:

1.1.0

setContentType

default void setContentType(@NonNull
                            java.lang.String contentType)

Parameters:

contentType - the content type of this upload request.

Since:

1.1.0