com.agorapulse.micronaut.amazon.awssdk.s3

Interface SimpleStorageService

All Known Implementing Classes:

DefaultSimpleStorageService

public interface SimpleStorageService

Service to simplify interaction with Amazon S3.

Method Summary

Modifier and Type	Method and Description
default void	createBucket() Creates new bucket of the name specified as aws.s3.bucket property.
void	createBucket(java.lang.String bucketName) Creates new bucket.
default void	deleteBucket() Creates new bucket of the name specified as aws.s3.bucket property.
void	deleteBucket(java.lang.String bucketName) Deletes existing bucket.
default boolean	deleteFile(java.lang.String key) Delete file specified by the object key.
boolean	deleteFile(java.lang.String bucketName, java.lang.String key) Delete file specified by the object key.
default boolean	deleteFiles(java.lang.String prefix) Delete all files specified by the common prefix (aka folder).
boolean	deleteFiles(java.lang.String bucketName, java.lang.String prefix) Delete all files specified by the common prefix (aka folder).
default boolean	exists(java.lang.String key) Check whether the object exists.
boolean	exists(java.lang.String bucketName, java.lang.String key) Check whether the object exists.
default java.lang.String	generatePresignedUrl(java.lang.String key, java.util.Date expirationDate) Generates the pre-signed URL for downloading an object by clients.
java.lang.String	generatePresignedUrl(java.lang.String bucketName, java.lang.String key, java.util.Date expirationDate) Generates the pre-signed URL for downloading an object by clients.
default java.lang.String	generateUploadUrl(java.lang.String key, java.util.Date expirationDate) Generates the pre-signed URL for uploading an object by clients.
java.lang.String	generateUploadUrl(java.lang.String bucketName, java.lang.String key, java.util.Date expirationDate) Generates the pre-signed URL for uploading an object by clients.
java.lang.String	getDefaultBucketName()
default java.io.File	getFile(java.lang.String key, java.io.File localPath) Downloads the file locally.
default java.io.File	getFile(java.lang.String key, java.lang.String localPath) Downloads the file locally.
java.io.File	getFile(java.lang.String bucketName, java.lang.String key, java.io.File localFile) Downloads the file locally.
default java.io.File	getFile(java.lang.String bucketName, java.lang.String key, java.lang.String localPath) Downloads the file locally.
default software.amazon.awssdk.services.s3.model.GetObjectResponse	getObject(java.lang.String key) Returns the information about the object
software.amazon.awssdk.services.s3.model.GetObjectResponse	getObject(java.lang.String bucketName, java.lang.String key) Returns the information about the object
default software.amazon.awssdk.services.s3.model.S3Object	getObjectSummary(java.lang.String key) Returns the object summary of an object
default software.amazon.awssdk.services.s3.model.S3Object	getObjectSummary(java.lang.String bucketName, java.lang.String key) Returns the object summary of an object
java.util.List<java.lang.String>	listBucketNames()
default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.ListObjectsV2Response>	listObjects() Returns the flowable of ObjectListing which each contains list of objects.
default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.ListObjectsV2Response>	listObjects(java.lang.String prefix) Returns the flowable of ObjectListing which each contains list of objects.
org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.ListObjectsV2Response>	listObjects(java.lang.String bucketName, java.lang.String prefix) Returns the flowable of ObjectListing which each contains list of objects.
default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.S3Object>	listObjectSummaries() Returns the flowable of object summaries.
default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.S3Object>	listObjectSummaries(java.lang.String prefix) Returns the flowable of object summaries.
default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.S3Object>	listObjectSummaries(java.lang.String bucketName, java.lang.String prefix) Returns the flowable of object summaries.
default java.lang.String	moveObject(java.lang.String sourceKey, java.lang.String destinationBucketName, java.lang.String destinationKey) Move S3 object to different location (key).
java.lang.String	moveObject(java.lang.String sourceBucketName, java.lang.String sourceKey, java.lang.String destinationBucketName, java.lang.String destinationKey) Move S3 object to different location (key).
default java.lang.String	storeFile(java.lang.String path, java.io.File file) Uploads data from the file to desired path on S3.
default java.lang.String	storeFile(java.lang.String path, java.io.File file, java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition) Uploads data from the file to desired path on S3.
default java.lang.String	storeFile(java.lang.String bucketName, java.lang.String path, java.io.File file) Uploads data from the file to desired path on S3.
java.lang.String	storeFile(java.lang.String bucketName, java.lang.String path, java.io.File file, java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition) Uploads data from the file to desired path on S3.
default java.lang.String	storeInputStream(java.lang.String path, java.io.InputStream input) Uploads data from the input stream to desired path on S3.
default java.lang.String	storeInputStream(java.lang.String path, java.io.InputStream input, java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition) Uploads data from the input stream to desired path on S3.
default java.lang.String	storeInputStream(java.lang.String bucketName, java.lang.String path, java.io.InputStream input) Uploads data from the input stream to desired path on S3.
java.lang.String	storeInputStream(java.lang.String bucketName, java.lang.String path, java.io.InputStream input, java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition) Uploads data from the input stream to desired path on S3.
default java.lang.String	storeMultipartFile(java.lang.String path, io.micronaut.http.multipart.PartData multipartFile) Uploads data from the multipart file to desired path on S3.
default java.lang.String	storeMultipartFile(java.lang.String path, io.micronaut.http.multipart.PartData multipartFile, java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition) Uploads data from the multipart file to desired path on S3.
default java.lang.String	storeMultipartFile(java.lang.String bucketName, java.lang.String path, io.micronaut.http.multipart.PartData partData) Uploads data from the multipart file to desired path on S3.
java.lang.String	storeMultipartFile(java.lang.String bucketName, java.lang.String path, io.micronaut.http.multipart.PartData partData, java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition) Uploads data from the multipart file to desired path on S3.

Method Detail

getDefaultBucketName

java.lang.String getDefaultBucketName()

Returns:

default name of the bucket

createBucket

void createBucket(java.lang.String bucketName)

Creates new bucket.

Parameters:

bucketName - the name of the bucket.

createBucket

default void createBucket()

Creates new bucket of the name specified as aws.s3.bucket property.

deleteBucket

void deleteBucket(java.lang.String bucketName)

Deletes existing bucket.

Parameters:

bucketName - the name of the bucket

deleteBucket

default void deleteBucket()

Creates new bucket of the name specified as aws.s3.bucket property.

deleteFile

boolean deleteFile(java.lang.String bucketName,
                   java.lang.String key)

Delete file specified by the object key.

Parameters:

bucketName - the name of the bucket

key - the key of the object

Returns:

true if the object has been deleted or did not exist

deleteFile

default boolean deleteFile(java.lang.String key)

Delete file specified by the object key.

Parameters:

key - the key of the object

Returns:

true if the object has been deleted or did not exist

deleteFiles

boolean deleteFiles(java.lang.String bucketName,
                    java.lang.String prefix)

Delete all files specified by the common prefix (aka folder).

Parameters:

bucketName - the name of the bucket

prefix - common prefix of the objects to be deleted

Returns:

true if the objects has been deleted

deleteFiles

default boolean deleteFiles(java.lang.String prefix)

Delete all files specified by the common prefix (aka folder).

Parameters:

prefix - common prefix of the objects to be deleted

Returns:

true if the objects has been deleted

exists

boolean exists(java.lang.String bucketName,
               java.lang.String key)

Check whether the object exists.

Parameters:

bucketName - the name of the bucket

key - the file key

Returns:

true if the file with given key exist

exists

default boolean exists(java.lang.String key)

Check whether the object exists.

Parameters:

key - the file key

Returns:

true if the file with given key exist

getFile

java.io.File getFile(java.lang.String bucketName,
                     java.lang.String key,
                     java.io.File localFile)

Downloads the file locally.

Parameters:

bucketName - the name of the bucket

key - the key of the object

localFile - the destination file

Returns:

the destination file

getFile

default java.io.File getFile(java.lang.String bucketName,
                             java.lang.String key,
                             java.lang.String localPath)

Downloads the file locally.

Parameters:

bucketName - the name of the bucket

key - the key of the object

localPath - the destination file's path

Returns:

the destination file

getFile

default java.io.File getFile(java.lang.String key,
                             java.io.File localPath)

Downloads the file locally.

Parameters:

key - the key of the object

localPath - the destination file's path

Returns:

the destination file

getFile

default java.io.File getFile(java.lang.String key,
                             java.lang.String localPath)

Downloads the file locally.

Parameters:

key - the key of the object

localPath - the destination file's path

Returns:

the destination file

listBucketNames

java.util.List<java.lang.String> listBucketNames()

Returns:

the list of all available buckets

listObjects

org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.ListObjectsV2Response> listObjects(java.lang.String bucketName,
                                                                                                          java.lang.String prefix)

Returns the flowable of ObjectListing which each contains list of objects. Use listObjectSummaries() to get flowable of object summaries themselves.

Parameters:

bucketName - the name of the bucket

prefix - the common prefix of the object being fetched

Returns:

the list of all objects available as flowable of ObjectListing which each contains list of objects.

listObjects

default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.ListObjectsV2Response> listObjects(java.lang.String prefix)

Returns the flowable of ObjectListing which each contains list of objects. Use listObjectSummaries() to get flowable of object summaries themselves.

Parameters:

prefix - the common prefix of the object being fetched

Returns:

the flowable of ObjectListing which each contains list of objects

listObjects

default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.ListObjectsV2Response> listObjects()

Returns the flowable of ObjectListing which each contains list of objects. Use listObjectSummaries() to get flowable of object summaries themselves.

Returns:

the flowable of ObjectListing which each contains list of objects

listObjectSummaries

default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.S3Object> listObjectSummaries(java.lang.String bucketName,
                                                                                                             java.lang.String prefix)

Returns the flowable of object summaries.

Parameters:

bucketName - the name of the bucket

prefix - the common prefix of the object being fetched

Returns:

the flowable of object summaries

getObject

default software.amazon.awssdk.services.s3.model.GetObjectResponse getObject(java.lang.String key)

Returns the information about the object

Parameters:

key - the key of the object

Returns:

the information about the object

getObject

software.amazon.awssdk.services.s3.model.GetObjectResponse getObject(java.lang.String bucketName,
                                                                     java.lang.String key)

Returns the information about the object

Parameters:

bucketName - the name of the bucket

key - the key of the object

Returns:

the information about the object

getObjectSummary

default software.amazon.awssdk.services.s3.model.S3Object getObjectSummary(java.lang.String key)

Returns the object summary of an object

Parameters:

key - the key of the object

Returns:

the object summary of an object

getObjectSummary

default software.amazon.awssdk.services.s3.model.S3Object getObjectSummary(java.lang.String bucketName,
                                                                           java.lang.String key)

Returns the object summary of an object

Parameters:

bucketName - the name of the bucket

key - the key of the object

Returns:

the object summary of an object

listObjectSummaries

default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.S3Object> listObjectSummaries(java.lang.String prefix)

Returns the flowable of object summaries.

Parameters:

prefix - the common prefix of the object being fetched

Returns:

the flowable of object summaries

listObjectSummaries

default org.reactivestreams.Publisher<software.amazon.awssdk.services.s3.model.S3Object> listObjectSummaries()

Returns the flowable of object summaries.

Returns:

the flowable of object summaries

generatePresignedUrl

java.lang.String generatePresignedUrl(java.lang.String bucketName,
                                      java.lang.String key,
                                      java.util.Date expirationDate)

Generates the pre-signed URL for downloading an object by clients.

Parameters:

bucketName - the name of the bucket

key - the key of the object

expirationDate - the expiration date of the link

Returns:

the URL to download the object without any credentials required

generatePresignedUrl

default java.lang.String generatePresignedUrl(java.lang.String key,
                                              java.util.Date expirationDate)

Generates the pre-signed URL for downloading an object by clients.

Parameters:

key - the key of the object

expirationDate - the expiration date of the link

Returns:

the URL to download the object without any credentials required

generateUploadUrl

java.lang.String generateUploadUrl(java.lang.String bucketName,
                                   java.lang.String key,
                                   java.util.Date expirationDate)

Generates the pre-signed URL for uploading an object by clients.

Parameters:

bucketName - the name of the bucket

key - the key of the object

expirationDate - the expiration date of the link

Returns:

the URL to upload the object without any credentials required

generateUploadUrl

default java.lang.String generateUploadUrl(java.lang.String key,
                                           java.util.Date expirationDate)

Generates the pre-signed URL for uploading an object by clients.

Parameters:

key - the key of the object

expirationDate - the expiration date of the link

Returns:

the URL to download the object without any credentials required

storeInputStream

java.lang.String storeInputStream(java.lang.String bucketName,
                                  java.lang.String path,
                                  java.io.InputStream input,
                                  java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition)

Uploads data from the input stream to desired path on S3.

Parameters:

bucketName - the name of the bucket

path - the destination path (key) on S3

input - the input data as stream

metadataDefinition - the object metadata definition

Returns:

the URL to newly created object

storeInputStream

default java.lang.String storeInputStream(java.lang.String path,
                                          java.io.InputStream input,
                                          java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition)

Uploads data from the input stream to desired path on S3.

Parameters:

path - the destination path (key) on S3

input - the input data as stream

metadataDefinition - the object metadata definition

Returns:

the URL to newly created object

storeInputStream

default java.lang.String storeInputStream(java.lang.String bucketName,
                                          java.lang.String path,
                                          java.io.InputStream input)

Uploads data from the input stream to desired path on S3.

Parameters:

bucketName - the name of the bucket

path - the destination path (key) on S3

input - the input data as stream

Returns:

the URL to newly created object

storeInputStream

default java.lang.String storeInputStream(java.lang.String path,
                                          java.io.InputStream input)

Uploads data from the input stream to desired path on S3.

Parameters:

path - the destination path (key) on S3

input - the input data as stream

Returns:

the URL to newly created object

storeFile

java.lang.String storeFile(java.lang.String bucketName,
                           java.lang.String path,
                           java.io.File file,
                           java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition)

Uploads data from the file to desired path on S3.

Parameters:

bucketName - the name of the bucket

path - the destination path (key) on S3

file - the input file

Returns:

the URL to newly created object

storeFile

default java.lang.String storeFile(java.lang.String path,
                                   java.io.File file,
                                   java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition)

Uploads data from the file to desired path on S3.

Parameters:

path - the destination path (key) on S3

file - the input file

Returns:

the URL to newly created object

storeFile

default java.lang.String storeFile(java.lang.String bucketName,
                                   java.lang.String path,
                                   java.io.File file)

Uploads data from the file to desired path on S3. WARNING: this method does not set the ACL to public write as the v1 version.

Parameters:

bucketName - the name of the bucket

path - the destination path (key) on S3

file - the input file

Returns:

the URL to newly created object

storeFile

default java.lang.String storeFile(java.lang.String path,
                                   java.io.File file)

Uploads data from the file to desired path on S3. WARNING: this method does not set the ACL to public write as the v1 version.

Parameters:

path - the destination path (key) on S3

file - the input file

Returns:

the URL to newly created object

storeMultipartFile

java.lang.String storeMultipartFile(java.lang.String bucketName,
                                    java.lang.String path,
                                    io.micronaut.http.multipart.PartData partData,
                                    java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition)
                             throws java.io.IOException

Uploads data from the multipart file to desired path on S3.

Parameters:

bucketName - the name of the bucket

path - the destination path (key) on S3

partData - the input data

metadataDefinition - the object metadata definition

Returns:

the URL to newly created object

Throws:

java.io.IOException

storeMultipartFile

default java.lang.String storeMultipartFile(java.lang.String bucketName,
                                            java.lang.String path,
                                            io.micronaut.http.multipart.PartData partData)
                                     throws java.io.IOException

Uploads data from the multipart file to desired path on S3.

Parameters:

bucketName - the name of the bucket

path - the destination path (key) on S3

partData - the input data

Returns:

the URL to newly created object

Throws:

java.io.IOException

storeMultipartFile

default java.lang.String storeMultipartFile(java.lang.String path,
                                            io.micronaut.http.multipart.PartData multipartFile)
                                     throws java.io.IOException

Uploads data from the multipart file to desired path on S3.

Parameters:

path - the destination path (key) on S3

Returns:

the URL to newly created object

Throws:

java.io.IOException

storeMultipartFile

default java.lang.String storeMultipartFile(java.lang.String path,
                                            io.micronaut.http.multipart.PartData multipartFile,
                                            java.util.function.Consumer<software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> metadataDefinition)
                                     throws java.io.IOException

Uploads data from the multipart file to desired path on S3.

Parameters:

path - the destination path (key) on S3

multipartFile - the input data

metadataDefinition - the object metadata definition

Returns:

the URL to newly created object

Throws:

java.io.IOException

moveObject

java.lang.String moveObject(java.lang.String sourceBucketName,
                            java.lang.String sourceKey,
                            java.lang.String destinationBucketName,
                            java.lang.String destinationKey)

Move S3 object to different location (key). Moving objects is useful in combination with S3 Lifecycle Configurations for prefixes.

Parameters:

sourceBucketName - the name of the source bucket

sourceKey - the key of the source object

destinationBucketName - the name of the destination bucket

destinationKey - the key of the destination object

Returns:

the destination URL or null if the file wasn't moved

moveObject

default java.lang.String moveObject(java.lang.String sourceKey,
                                    java.lang.String destinationBucketName,
                                    java.lang.String destinationKey)

Move S3 object to different location (key). Moving objects is useful in combination with S3 Lifecycle Configurations for prefixes.

Parameters:

sourceKey - the key of the source object

destinationBucketName - the name of the destination bucket

destinationKey - the key of the destination object

Returns:

the destination URL or null if the file wasn't moved