io.micronaut.objectstorage.request

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 io.micronaut.objectstorage.request.AbstractUploadRequest

contentType, metadata

Constructor Summary

Constructors

Constructor and Description
FileUploadRequest(java.nio.file.Path localFilePath)
FileUploadRequest(java.nio.file.Path localFilePath, java.lang.String prefix)
FileUploadRequest(java.nio.file.Path localFilePath, java.lang.String keyName, java.lang.String prefix, java.lang.String contentType)
FileUploadRequest(java.lang.String keyName, java.lang.String contentType, java.nio.file.Path path, java.util.Map<java.lang.String,java.lang.String> metadata)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAbsolutePath()
java.util.Optional<java.lang.Long>	getContentSize()
java.util.Optional<java.lang.String>	getContentType()
java.io.File	getFile()
java.io.InputStream	getInputStream()
java.lang.String	getKey()
java.nio.file.Path	getPath()

Methods inherited from class io.micronaut.objectstorage.request.AbstractUploadRequest

getMetadata, setContentType, setMetadata

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, getMetadata, setContentType, setMetadata

Constructor Detail

FileUploadRequest

public FileUploadRequest(@NonNull
                         java.nio.file.Path localFilePath)

FileUploadRequest

public FileUploadRequest(@NonNull
                         java.nio.file.Path localFilePath,
                         @Nullable
                         java.lang.String prefix)

FileUploadRequest

public FileUploadRequest(@NonNull
                         java.nio.file.Path localFilePath,
                         @NonNull
                         java.lang.String keyName,
                         @Nullable
                         java.lang.String prefix,
                         @Nullable
                         java.lang.String contentType)

FileUploadRequest

public FileUploadRequest(@NonNull
                         java.lang.String keyName,
                         @Nullable
                         java.lang.String contentType,
                         @NonNull
                         java.nio.file.Path path,
                         @NonNull
                         java.util.Map<java.lang.String,java.lang.String> metadata)

Method Detail

getFile

@NonNull
public java.io.File getFile()

Returns:

The File associated with the underlying Path.

getPath

@NonNull
public java.nio.file.Path getPath()

Returns:

The underlying Path.

getAbsolutePath

@NonNull
public java.lang.String getAbsolutePath()

Returns:

The absolute path of the underlying Path.

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.