org.finra.herd.dao.impl

Class S3OperationsImpl

java.lang.Object

org.finra.herd.dao.impl.S3OperationsImpl

All Implemented Interfaces:

S3Operations

public class S3OperationsImpl
extends Object
implements S3Operations

Field Summary

Fields inherited from interface org.finra.herd.dao.S3Operations

ERROR_CODE_ACCESS_DENIED, ERROR_CODE_INTERNAL_ERROR, ERROR_CODE_NO_SUCH_BUCKET, ERROR_CODE_NO_SUCH_KEY

Constructor Summary

Constructors

Constructor and Description
S3OperationsImpl()

Method Summary

Modifier and Type	Method and Description
void	abortMultipartUpload(com.amazonaws.services.s3.model.AbortMultipartUploadRequest abortMultipartUploadRequest, com.amazonaws.services.s3.AmazonS3Client s3Client) Aborts the specified multipart upload.
com.amazonaws.services.s3.transfer.Copy	copyFile(com.amazonaws.services.s3.model.CopyObjectRequest copyObjectRequest, com.amazonaws.services.s3.transfer.TransferManager transferManager) Copy the S3 object from source to target S3 bucket.
com.amazonaws.services.s3.model.DeleteObjectsResult	deleteObjects(com.amazonaws.services.s3.model.DeleteObjectsRequest deleteObjectsRequest, com.amazonaws.services.s3.AmazonS3Client s3Client) Delete the objects.
com.amazonaws.services.s3.transfer.Download	download(String bucket, String key, File file, com.amazonaws.services.s3.transfer.TransferManager transferManager) Implementation delegates to TransferManager.download(String, String, File)
com.amazonaws.services.s3.transfer.MultipleFileDownload	downloadDirectory(String bucketName, String keyPrefix, File destinationDirectory, com.amazonaws.services.s3.transfer.TransferManager transferManager) Implementation delegates to TransferManager.downloadDirectory(String, String, File).
URL	generatePresignedUrl(com.amazonaws.services.s3.model.GeneratePresignedUrlRequest generatePresignedUrlRequest, com.amazonaws.services.s3.AmazonS3 s3) AmazonS3.generatePresignedUrl(GeneratePresignedUrlRequest)
com.amazonaws.services.s3.model.ObjectMetadata	getObjectMetadata(String sourceBucketName, String filePath, com.amazonaws.services.s3.AmazonS3Client s3Client) Get the S3 object meta data.
com.amazonaws.services.s3.model.S3Object	getS3Object(com.amazonaws.services.s3.model.GetObjectRequest getObjectRequest, com.amazonaws.services.s3.AmazonS3 s3)
com.amazonaws.services.s3.model.MultipartUploadListing	listMultipartUploads(com.amazonaws.services.s3.model.ListMultipartUploadsRequest listMultipartUploadsRequest, com.amazonaws.services.s3.AmazonS3Client s3Client) Lists multipart uploads.
com.amazonaws.services.s3.model.ObjectListing	listObjects(com.amazonaws.services.s3.model.ListObjectsRequest listObjectsRequest, com.amazonaws.services.s3.AmazonS3Client s3Client) List the objects.
com.amazonaws.services.s3.model.VersionListing	listVersions(com.amazonaws.services.s3.model.ListVersionsRequest listVersionsRequest, com.amazonaws.services.s3.AmazonS3Client s3Client) List the versions.
com.amazonaws.services.s3.model.PutObjectResult	putObject(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest, com.amazonaws.services.s3.AmazonS3Client s3Client) Put an object.
void	restoreObject(com.amazonaws.services.s3.model.RestoreObjectRequest requestRestore, com.amazonaws.services.s3.AmazonS3Client s3Client) Requests to restore a key in the specified bucket.
void	rollback() Rollback is not supported.
com.amazonaws.services.s3.transfer.Upload	upload(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest, com.amazonaws.services.s3.transfer.TransferManager transferManager) Implementation delegates to TransferManager.upload(PutObjectRequest).
com.amazonaws.services.s3.transfer.MultipleFileUpload	uploadDirectory(String bucketName, String virtualDirectoryKeyPrefix, File directory, boolean includeSubdirectories, com.amazonaws.services.s3.transfer.ObjectMetadataProvider metadataProvider, com.amazonaws.services.s3.transfer.TransferManager transferManager) Implementation delegates to TransferManager.uploadDirectory(String, String, File, boolean, ObjectMetadataProvider)
com.amazonaws.services.s3.transfer.MultipleFileUpload	uploadFileList(String bucketName, String virtualDirectoryKeyPrefix, File directory, List<File> files, com.amazonaws.services.s3.transfer.ObjectMetadataProvider metadataProvider, com.amazonaws.services.s3.transfer.TransferManager transferManager) Implementation delegates to TransferManager.uploadFileList(String, String, File, List, ObjectMetadataProvider).

Methods inherited from class java.lang.Object

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

Constructor Detail

S3OperationsImpl

public S3OperationsImpl()

Method Detail

getObjectMetadata

public com.amazonaws.services.s3.model.ObjectMetadata getObjectMetadata(String sourceBucketName,
                                                                        String filePath,
                                                                        com.amazonaws.services.s3.AmazonS3Client s3Client)

Description copied from interface: S3Operations

Get the S3 object meta data.

Specified by:

getObjectMetadata in interface S3Operations

copyFile

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

Description copied from interface: S3Operations

Copy the S3 object from source to target S3 bucket.

Specified by:

copyFile in interface S3Operations

restoreObject

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

Description copied from interface: S3Operations

Requests to restore a key in the specified bucket.

Specified by:

restoreObject in interface S3Operations

Parameters:

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

s3Client - the AmazonS3 implementation to use

listMultipartUploads

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

Description copied from interface: S3Operations

Lists multipart uploads.

Specified by:

listMultipartUploads in interface S3Operations

abortMultipartUpload

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

Description copied from interface: S3Operations

Aborts the specified multipart upload.

Specified by:

abortMultipartUpload in interface S3Operations

deleteObjects

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

Description copied from interface: S3Operations

Delete the objects.

Specified by:

deleteObjects in interface S3Operations

listObjects

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

Description copied from interface: S3Operations

List the objects.

Specified by:

listObjects in interface S3Operations

Returns:

object listing.

listVersions

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

Description copied from interface: S3Operations

List the versions.

Specified by:

listVersions in interface S3Operations

Returns:

version listing.

putObject

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

Description copied from interface: S3Operations

Put an object.

Specified by:

putObject in interface S3Operations

uploadDirectory

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

Implementation delegates to TransferManager.uploadDirectory(String, String, File, boolean, ObjectMetadataProvider)

Specified by:

uploadDirectory in interface S3Operations

Parameters:

bucketName - the bucket name.

virtualDirectoryKeyPrefix - the virtual directory key prefix.

directory - the directory.

includeSubdirectories - flag that determines whether to include sub-directories or not.

metadataProvider - the metadata provider.

transferManager - the transfer manager.

Returns:

the multiple file upload information.

downloadDirectory

public com.amazonaws.services.s3.transfer.MultipleFileDownload downloadDirectory(String bucketName,
                                                                                 String keyPrefix,
                                                                                 File destinationDirectory,
                                                                                 com.amazonaws.services.s3.transfer.TransferManager transferManager)

Implementation delegates to TransferManager.downloadDirectory(String, String, File).

Specified by:

downloadDirectory in interface S3Operations

Parameters:

bucketName - the bucket name.

keyPrefix - the S3 key prefix.

destinationDirectory - the destination directory.

transferManager - the transfer manager.

Returns:

the multiple file download information.

upload

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

Implementation delegates to TransferManager.upload(PutObjectRequest).

Specified by:

upload in interface S3Operations

Parameters:

putObjectRequest - the put object request.

transferManager - the transfer manager.

Returns:

the upload information.

Throws:

com.amazonaws.AmazonClientException - if an Amazon client exception occurs

com.amazonaws.AmazonServiceException

uploadFileList

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

Implementation delegates to TransferManager.uploadFileList(String, String, File, List, ObjectMetadataProvider).

Specified by:

uploadFileList in interface S3Operations

download

public com.amazonaws.services.s3.transfer.Download download(String bucket,
                                                            String key,
                                                            File file,
                                                            com.amazonaws.services.s3.transfer.TransferManager transferManager)

Implementation delegates to TransferManager.download(String, String, File)

Specified by:

download in interface S3Operations

rollback

public void rollback()

Rollback is not supported.

Specified by:

rollback in interface S3Operations

getS3Object

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

Specified by:

getS3Object in interface S3Operations

generatePresignedUrl

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

Description copied from interface: S3Operations

AmazonS3.generatePresignedUrl(GeneratePresignedUrlRequest)

Specified by:

generatePresignedUrl in interface S3Operations

Parameters:

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

s3 - The AmazonS3 implementation to use

Returns:

A pre-signed URL that can be used to access an Amazon S3 resource without requiring the user of the URL to know the account's AWS security credentials.