Class FileUploadRequest

java.lang.Object

io.micronaut.objectstorage.request.AbstractUploadRequest

io.micronaut.objectstorage.request.FileUploadRequest

All Implemented Interfaces:

UploadRequest

public class FileUploadRequest
extends AbstractUploadRequest
implements UploadRequest

Upload request implementation using File.

Field Summary

Fields inherited from class AbstractUploadRequest

contentType, metadata

Constructor Summary

Constructors

Constructor	Description
FileUploadRequest(@NonNull String keyName, @Nullable String contentType, @NonNull Path path, @NonNull Map<String,String> metadata)
FileUploadRequest(@NonNull Path localFilePath)
FileUploadRequest(@NonNull Path localFilePath, @NonNull String keyName, @Nullable String prefix, @Nullable String contentType)
FileUploadRequest(@NonNull Path localFilePath, @Nullable String prefix)

Method Summary

Modifier and Type	Method	Description
@NonNull String	getAbsolutePath()
@NonNull Optional<Long>	getContentSize()
@NonNull Optional<String>	getContentType()
@NonNull File	getFile()
@NonNull InputStream	getInputStream()	Returns an input stream of the object to be stored.
@NonNull String	getKey()
@NonNull Path	getPath()

Methods inherited from class AbstractUploadRequest

getMetadata, setContentType, setMetadata

Methods inherited from class Object

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

Methods inherited from interface UploadRequest

getMetadata, setContentType, setMetadata

Constructor Details

FileUploadRequest

public FileUploadRequest(@NonNull Path localFilePath)

FileUploadRequest

public FileUploadRequest(@NonNull Path localFilePath,
 @Nullable String prefix)

FileUploadRequest

public FileUploadRequest(@NonNull Path localFilePath,
 @NonNull String keyName,
 @Nullable String prefix,
 @Nullable String contentType)

FileUploadRequest

public FileUploadRequest(@NonNull String keyName,
 @Nullable String contentType,
 @NonNull Path path,
 @NonNull Map<String,String> metadata)

Method Details

getFile

public @NonNull File getFile()

Returns:

The File associated with the underlying Path.

getPath

public @NonNull Path getPath()

Returns:

The underlying Path.

getAbsolutePath

public @NonNull String getAbsolutePath()

Returns:

The absolute path of the underlying Path.

getContentType

public @NonNull Optional<String> getContentType()

Specified by:

getContentType in interface UploadRequest

Returns:

the content type of this upload request.

getKey

public @NonNull String getKey()

Specified by:

getKey in interface UploadRequest

Returns:

the file name with path.

getContentSize

public @NonNull Optional<Long> getContentSize()

Specified by:

getContentSize in interface UploadRequest

Returns:

the size of the file, in bytes.

getInputStream

public @NonNull InputStream getInputStream()

Description copied from interface: UploadRequest

Returns an input stream of the object to be stored.

Callers must not access the stream while an upload is in progress. Provider implementations may close it, so callers that own the stream should ensure it is closed after a blocking upload returns or after a reactive upload terminates.

Specified by:

getInputStream in interface UploadRequest

Returns:

an input stream of the object to be stored.