org.finra.herd.dao

Interface S3Operations

All Known Implementing Classes:

S3OperationsImpl

public interface S3Operations

AWS S3 Operations Service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_CODE_ACCESS_DENIED
static String	ERROR_CODE_INTERNAL_ERROR
static String	ERROR_CODE_NO_SUCH_BUCKET
static String	ERROR_CODE_NO_SUCH_KEY

Method Summary

Modifier and Type	Method and Description
void	abortMultipartUpload(com.amazonaws.services.s3.model.AbortMultipartUploadRequest abortMultipartUploadRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Aborts a multipart upload.
com.amazonaws.services.s3.transfer.Copy	copyFile(com.amazonaws.services.s3.model.CopyObjectRequest copyObjectRequest, com.amazonaws.services.s3.transfer.TransferManager transferManager) Schedules a new transfer to copy data from one Amazon S3 location to another Amazon S3 location.
com.amazonaws.services.s3.model.DeleteObjectsResult	deleteObjects(com.amazonaws.services.s3.model.DeleteObjectsRequest deleteObjectsRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Deletes the specified S3 objects in the specified S3 bucket.
com.amazonaws.services.s3.transfer.Download	download(String s3BucketName, String s3Key, File file, com.amazonaws.services.s3.transfer.TransferManager transferManager) Schedules a new transfer to download data from Amazon S3 and save it to the specified file.
com.amazonaws.services.s3.transfer.MultipleFileDownload	downloadDirectory(String s3BucketName, String s3KeyPrefix, File destinationDirectory, com.amazonaws.services.s3.transfer.TransferManager transferManager) Downloads all objects in the virtual directory designated by the key prefix given to the destination directory given.
URL	generatePresignedUrl(com.amazonaws.services.s3.model.GeneratePresignedUrlRequest generatePresignedUrlRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Returns a pre-signed URL for accessing an Amazon S3 resource.
com.amazonaws.services.s3.model.ObjectMetadata	getObjectMetadata(String s3BucketName, String s3Key, com.amazonaws.services.s3.AmazonS3 s3Client) Gets the metadata for the specified Amazon S3 object without actually fetching the object itself.
com.amazonaws.services.s3.model.GetObjectTaggingResult	getObjectTagging(com.amazonaws.services.s3.model.GetObjectTaggingRequest getObjectTaggingRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Returns all S3 object tags for the specified object.
com.amazonaws.services.s3.model.S3Object	getS3Object(com.amazonaws.services.s3.model.GetObjectRequest getObjectRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Gets the object stored in Amazon S3 under the specified bucket and key.
com.amazonaws.services.s3.model.MultipartUploadListing	listMultipartUploads(com.amazonaws.services.s3.model.ListMultipartUploadsRequest listMultipartUploadsRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Lists in-progress multipart uploads.
com.amazonaws.services.s3.model.ObjectListing	listObjects(com.amazonaws.services.s3.model.ListObjectsRequest listObjectsRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Returns a list of summary information about the objects in the specified bucket.
com.amazonaws.services.s3.model.VersionListing	listVersions(com.amazonaws.services.s3.model.ListVersionsRequest listVersionsRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Returns a list of summary information about the versions in the specified bucket.
com.amazonaws.services.s3.model.PutObjectResult	putObject(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Uploads a new object to the specified Amazon S3 bucket.
void	restoreObject(com.amazonaws.services.s3.model.RestoreObjectRequest requestRestore, com.amazonaws.services.s3.AmazonS3 s3Client) Requests to restore an object, which was transitioned to Amazon Glacier from Amazon S3 when it was expired, into Amazon S3 again.
void	rollback() Rolls back any updates to S3 within a given session.
com.amazonaws.services.s3.model.SetObjectTaggingResult	setObjectTagging(com.amazonaws.services.s3.model.SetObjectTaggingRequest setObjectTaggingRequest, com.amazonaws.services.s3.AmazonS3 s3Client) Set the tags for the specified object.
com.amazonaws.services.s3.transfer.Upload	upload(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest, com.amazonaws.services.s3.transfer.TransferManager transferManager) Schedules a new transfer to upload data to Amazon S3.
com.amazonaws.services.s3.transfer.MultipleFileUpload	uploadDirectory(String s3BucketName, String virtualDirectoryKeyPrefix, File directory, boolean includeSubdirectories, com.amazonaws.services.s3.transfer.ObjectMetadataProvider metadataProvider, com.amazonaws.services.s3.transfer.TransferManager transferManager) Uploads all files in the directory given to the bucket named, optionally recursing for all subdirectories.
com.amazonaws.services.s3.transfer.MultipleFileUpload	uploadFileList(String s3BucketName, String virtualDirectoryKeyPrefix, File directory, List<File> files, com.amazonaws.services.s3.transfer.ObjectMetadataProvider metadataProvider, com.amazonaws.services.s3.transfer.TransferManager transferManager) Uploads all specified files to the bucket named, constructing relative keys depending on the common parent directory given.

Field Detail

ERROR_CODE_ACCESS_DENIED

static final String ERROR_CODE_ACCESS_DENIED

See Also:

Constant Field Values

ERROR_CODE_INTERNAL_ERROR

static final String ERROR_CODE_INTERNAL_ERROR

See Also:

Constant Field Values

ERROR_CODE_NO_SUCH_BUCKET

static final String ERROR_CODE_NO_SUCH_BUCKET

See Also:

Constant Field Values

ERROR_CODE_NO_SUCH_KEY

static final String ERROR_CODE_NO_SUCH_KEY

See Also:

Constant Field Values

Method Detail

abortMultipartUpload

void abortMultipartUpload(com.amazonaws.services.s3.model.AbortMultipartUploadRequest abortMultipartUploadRequest,
                          com.amazonaws.services.s3.AmazonS3 s3Client)

Aborts a multipart upload.

Parameters:

abortMultipartUploadRequest - the request object containing all the parameters for the operation

s3Client - the AmazonS3 implementation to use

copyFile

com.amazonaws.services.s3.transfer.Copy copyFile(com.amazonaws.services.s3.model.CopyObjectRequest copyObjectRequest,
                                                 com.amazonaws.services.s3.transfer.TransferManager transferManager)

Schedules a new transfer to copy data from one Amazon S3 location to another Amazon S3 location.

Parameters:

copyObjectRequest - the request containing all the parameters for the copy

transferManager - the transfer manager implementation to use

deleteObjects

com.amazonaws.services.s3.model.DeleteObjectsResult deleteObjects(com.amazonaws.services.s3.model.DeleteObjectsRequest deleteObjectsRequest,
                                                                  com.amazonaws.services.s3.AmazonS3 s3Client)

Deletes the specified S3 objects in the specified S3 bucket.

Parameters:

deleteObjectsRequest - the request object containing all the options for deleting multiple objects in a specified bucket

s3Client - the AmazonS3 implementation to use

Returns:

the successful response to the delete object request

download

com.amazonaws.services.s3.transfer.Download download(String s3BucketName,
                                                     String s3Key,
                                                     File file,
                                                     com.amazonaws.services.s3.transfer.TransferManager transferManager)

Schedules a new transfer to download data from Amazon S3 and save it to the specified file.

Parameters:

s3BucketName - the S3 bucket name

s3Key - the S3 key

file - the destination file

transferManager - the transfer manager implementation to use

Returns:

the object that represents an asynchronous download from Amazon S3

downloadDirectory

com.amazonaws.services.s3.transfer.MultipleFileDownload downloadDirectory(String s3BucketName,
                                                                          String s3KeyPrefix,
                                                                          File destinationDirectory,
                                                                          com.amazonaws.services.s3.transfer.TransferManager transferManager)

Downloads all objects in the virtual directory designated by the key prefix given to the destination directory given.

Parameters:

s3BucketName - the S3 bucket name

s3KeyPrefix - the S3 key prefix

destinationDirectory - the destination directory

transferManager - the transfer manager implementation to use

Returns:

the object that represents an asynchronous multiple file download of an entire virtual directory

generatePresignedUrl

URL generatePresignedUrl(com.amazonaws.services.s3.model.GeneratePresignedUrlRequest generatePresignedUrlRequest,
                         com.amazonaws.services.s3.AmazonS3 s3Client)

Returns a pre-signed URL for accessing an Amazon S3 resource.

Parameters:

generatePresignedUrlRequest - the request object containing all the options for generating a pre-signed URL (bucket name, key, expiration date, etc)

s3Client - the AmazonS3 implementation to use

Returns:

the pre-signed URL which expires at the specified time, and can be used to allow anyone to download the specified object from S3, without exposing the owner's AWS secret access key

getObjectMetadata

com.amazonaws.services.s3.model.ObjectMetadata getObjectMetadata(String s3BucketName,
                                                                 String s3Key,
                                                                 com.amazonaws.services.s3.AmazonS3 s3Client)

Gets the metadata for the specified Amazon S3 object without actually fetching the object itself.

Parameters:

s3BucketName - the S3 bucket name

s3Key - the S3 key

s3Client - the AmazonS3 implementation to use

Returns:

the Amazon S3 object metadata for the specified object

getObjectTagging

com.amazonaws.services.s3.model.GetObjectTaggingResult getObjectTagging(com.amazonaws.services.s3.model.GetObjectTaggingRequest getObjectTaggingRequest,
                                                                        com.amazonaws.services.s3.AmazonS3 s3Client)

Returns all S3 object tags for the specified object.

Parameters:

getObjectTaggingRequest - the request object containing all the options on how to retrieve the Amazon S3 object tags

s3Client - the AmazonS3 implementation to use

Returns:

the set of S3 object tags

getS3Object

com.amazonaws.services.s3.model.S3Object getS3Object(com.amazonaws.services.s3.model.GetObjectRequest getObjectRequest,
                                                     com.amazonaws.services.s3.AmazonS3 s3Client)

Gets the object stored in Amazon S3 under the specified bucket and key.

Parameters:

getObjectRequest - the request object containing all the options for downloading an Amazon S3 object

s3Client - the AmazonS3 implementation to use

Returns:

the object stored in Amazon S3

listMultipartUploads

com.amazonaws.services.s3.model.MultipartUploadListing listMultipartUploads(com.amazonaws.services.s3.model.ListMultipartUploadsRequest listMultipartUploadsRequest,
                                                                            com.amazonaws.services.s3.AmazonS3 s3Client)

Lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated, but has not yet been completed or aborted. This operation returns at most 1,000 multipart uploads in the response by default.

Parameters:

listMultipartUploadsRequest - the request object that specifies all the parameters of this operation

s3Client - the AmazonS3 implementation to use

Returns:

the listing of multipart uploads from Amazon S3

listObjects

com.amazonaws.services.s3.model.ObjectListing listObjects(com.amazonaws.services.s3.model.ListObjectsRequest listObjectsRequest,
                                                          com.amazonaws.services.s3.AmazonS3 s3Client)

Returns a list of summary information about the objects in the specified bucket.

Parameters:

listObjectsRequest - the request object containing all options for listing the objects in a specified bucket

s3Client - the AmazonS3 implementation to use

Returns:

the listing of the objects in the specified bucket

listVersions

com.amazonaws.services.s3.model.VersionListing listVersions(com.amazonaws.services.s3.model.ListVersionsRequest listVersionsRequest,
                                                            com.amazonaws.services.s3.AmazonS3 s3Client)

Returns a list of summary information about the versions in the specified bucket.

Parameters:

listVersionsRequest - the request object containing all options for listing the versions in a specified bucket

s3Client - the AmazonS3 implementation to use

Returns:

the listing of the versions in the specified bucket

putObject

com.amazonaws.services.s3.model.PutObjectResult putObject(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest,
                                                          com.amazonaws.services.s3.AmazonS3 s3Client)

Uploads a new object to the specified Amazon S3 bucket.

Parameters:

putObjectRequest - the request object containing all the parameters to upload a new object to Amazon S3

s3Client - the AmazonS3 implementation to use

Returns:

the object containing the information returned by Amazon S3 for the newly created object

restoreObject

void restoreObject(com.amazonaws.services.s3.model.RestoreObjectRequest requestRestore,
                   com.amazonaws.services.s3.AmazonS3 s3Client)

Requests to restore an object, which was transitioned to Amazon Glacier from Amazon S3 when it was expired, into Amazon S3 again.

Parameters:

requestRestore - the request object containing all the options for restoring an object

s3Client - the AmazonS3 implementation to use

rollback

void rollback()

Rolls back any updates to S3 within a given session. Whether rollback is supported or not is implementation dependent.

setObjectTagging

com.amazonaws.services.s3.model.SetObjectTaggingResult setObjectTagging(com.amazonaws.services.s3.model.SetObjectTaggingRequest setObjectTaggingRequest,
                                                                        com.amazonaws.services.s3.AmazonS3 s3Client)

Set the tags for the specified object.

Parameters:

setObjectTaggingRequest - the request object containing all the options for setting the tags for the specified object

s3Client - the AmazonS3 implementation to use

Returns:

the result of the set operation

upload

com.amazonaws.services.s3.transfer.Upload upload(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest,
                                                 com.amazonaws.services.s3.transfer.TransferManager transferManager)

Schedules a new transfer to upload data to Amazon S3.

Parameters:

putObjectRequest - the request containing all the parameters for the upload

transferManager - the transfer manager implementation to use

Returns:

the object to use to check the state of the upload, listen for progress notifications, and otherwise manage the upload

uploadDirectory

com.amazonaws.services.s3.transfer.MultipleFileUpload uploadDirectory(String s3BucketName,
                                                                      String virtualDirectoryKeyPrefix,
                                                                      File directory,
                                                                      boolean includeSubdirectories,
                                                                      com.amazonaws.services.s3.transfer.ObjectMetadataProvider metadataProvider,
                                                                      com.amazonaws.services.s3.transfer.TransferManager transferManager)

Uploads all files in the directory given to the bucket named, optionally recursing for all subdirectories.

Parameters:

s3BucketName - the S3 bucket name

virtualDirectoryKeyPrefix - the key prefix of the virtual directory to upload to

directory - the directory to upload

includeSubdirectories - specified whether to include subdirectories in the upload. If true, files found in subdirectories will be included with an appropriate concatenation to the key prefix

metadataProvider - the callback of type ObjectMetadataProvider which is used to provide metadata for each file being uploaded

transferManager - the transfer manager implementation to use

Returns:

the multiple file upload information

uploadFileList

com.amazonaws.services.s3.transfer.MultipleFileUpload uploadFileList(String s3BucketName,
                                                                     String virtualDirectoryKeyPrefix,
                                                                     File directory,
                                                                     List<File> files,
                                                                     com.amazonaws.services.s3.transfer.ObjectMetadataProvider metadataProvider,
                                                                     com.amazonaws.services.s3.transfer.TransferManager transferManager)

Uploads all specified files to the bucket named, constructing relative keys depending on the common parent directory given.

Parameters:

s3BucketName - the S3 bucket name

virtualDirectoryKeyPrefix - the key prefix of the virtual directory to upload to

directory - the common parent directory of files to upload. The keys of the files in the list of files are constructed relative to this directory and the virtualDirectoryKeyPrefix

files - the list of files to upload. The keys of the files are calculated relative to the common parent directory and the virtualDirectoryKeyPrefix

metadataProvider - the callback of type ObjectMetadataProvider which is used to provide metadata for each file being uploaded

transferManager - the transfer manager implementation to use

Returns:

the multiple file upload information