org.finra.herd.service.impl

Class S3ServiceImpl

java.lang.Object

org.finra.herd.service.impl.S3ServiceImpl

All Implemented Interfaces:

S3Service

@Service
 @Transactional(value="herdTransactionManager")
public class S3ServiceImpl
extends Object
implements S3Service

The S3 service implementation.

Constructor Summary

Constructors

Constructor and Description
S3ServiceImpl()

Method Summary

Modifier and Type	Method and Description
S3FileTransferResultsDto	copyFile(S3FileCopyRequestParamsDto params) Copies an S3 object from the source S3 bucket to the same path in target bucket.
void	createDirectory(S3FileTransferRequestParamsDto params) Creates an S3 object of 0 byte size that represents a directory.
void	deleteDirectory(S3FileTransferRequestParamsDto params) Deletes keys/key versions from specified bucket with matching prefix.
void	deleteDirectoryIgnoreException(S3FileTransferRequestParamsDto params) Deletes keys/objects from specified bucket with matching prefix.
void	deleteFileList(S3FileTransferRequestParamsDto params) Deletes a list of keys from specified bucket.
S3FileTransferResultsDto	downloadDirectory(S3FileTransferRequestParamsDto params) Downloads a directory from S3 to the local file system.
S3FileTransferResultsDto	downloadFile(S3FileTransferRequestParamsDto params) Downloads a file from S3 to the local file system.
List<com.amazonaws.services.s3.model.S3ObjectSummary>	listDirectory(S3FileTransferRequestParamsDto params) Lists all S3 objects matching the S3 key prefix in the given bucket (S3 bucket name).
List<com.amazonaws.services.s3.model.S3ObjectSummary>	listDirectory(S3FileTransferRequestParamsDto params, boolean ignoreZeroByteDirectoryMarkers) Lists all S3 objects matching the S3 key prefix in the given bucket (S3 bucket name).
List<com.amazonaws.services.s3.model.S3VersionSummary>	listVersions(S3FileTransferRequestParamsDto params) Lists all S3 versions matching the S3 key prefix in the given bucket (S3 bucket name).
void	restoreObjects(S3FileTransferRequestParamsDto params, int expirationInDays, String archiveRetrievalOption) Requests to restore a list of keys in the specified bucket.
void	tagObjects(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto, S3FileTransferRequestParamsDto s3ObjectTaggerParamsDto, List<com.amazonaws.services.s3.model.S3ObjectSummary> s3ObjectSummaries, com.amazonaws.services.s3.model.Tag tag) Tags S3 objects with the specified S3 object tag.
void	tagVersions(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto, S3FileTransferRequestParamsDto s3ObjectTaggerParamsDto, List<com.amazonaws.services.s3.model.S3VersionSummary> s3VersionSummaries, com.amazonaws.services.s3.model.Tag tag) Tags S3 versions with the specified S3 object tag.
S3FileTransferResultsDto	uploadDirectory(S3FileTransferRequestParamsDto params) Uploads a local directory of files into S3.
S3FileTransferResultsDto	uploadFile(S3FileTransferRequestParamsDto params) Uploads a local file into S3.
S3FileTransferResultsDto	uploadFileList(S3FileTransferRequestParamsDto params) Uploads a list of local files into S3.
void	validateGlacierS3FilesRestored(S3FileTransferRequestParamsDto params) Validates that all specified Glacier storage class files are restored.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ServiceImpl

public S3ServiceImpl()

Method Detail

copyFile

public S3FileTransferResultsDto copyFile(S3FileCopyRequestParamsDto params)
                                  throws InterruptedException

Description copied from interface: S3Service

Copies an S3 object from the source S3 bucket to the same path in target bucket. This method does not delete the source S3 object.

Specified by:

copyFile in interface S3Service

Parameters:

params - the S3 file copy request parameters.

Returns:

the results.

Throws:

InterruptedException - if any problems were encountered.

createDirectory

public void createDirectory(S3FileTransferRequestParamsDto params)

Description copied from interface: S3Service

Creates an S3 object of 0 byte size that represents a directory.

Specified by:

createDirectory in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 object to be created.

deleteDirectory

public void deleteDirectory(S3FileTransferRequestParamsDto params)

Description copied from interface: S3Service

Deletes keys/key versions from specified bucket with matching prefix.

Specified by:

deleteDirectory in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 objects to be deleted.

deleteDirectoryIgnoreException

public void deleteDirectoryIgnoreException(S3FileTransferRequestParamsDto params)

Description copied from interface: S3Service

Deletes keys/objects from specified bucket with matching prefix. This method does not fail in case cleaning is unsuccessful, but simply logs the exception information as a warning.

Specified by:

deleteDirectoryIgnoreException in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 objects to be deleted.

deleteFileList

public void deleteFileList(S3FileTransferRequestParamsDto params)

Description copied from interface: S3Service

Deletes a list of keys from specified bucket.

Specified by:

deleteFileList in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and the file list identify the S3 objects to be deleted.

downloadDirectory

public S3FileTransferResultsDto downloadDirectory(S3FileTransferRequestParamsDto params)
                                           throws InterruptedException

Description copied from interface: S3Service

Downloads a directory from S3 to the local file system.

Specified by:

downloadDirectory in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix are for the source of the copy. The local path is the local directory where the downloaded files will be copied into.

Returns:

the results.

Throws:

InterruptedException - if any problems were encountered.

downloadFile

public S3FileTransferResultsDto downloadFile(S3FileTransferRequestParamsDto params)
                                      throws InterruptedException

Description copied from interface: S3Service

Downloads a file from S3 to the local file system.

Specified by:

downloadFile in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix are for the source of the copy. The local path is the local file name where the downloaded file will be copied into.

Returns:

the results.

Throws:

InterruptedException - if any problems were encountered.

listDirectory

public List<com.amazonaws.services.s3.model.S3ObjectSummary> listDirectory(S3FileTransferRequestParamsDto params)

Description copied from interface: S3Service

Lists all S3 objects matching the S3 key prefix in the given bucket (S3 bucket name).

Specified by:

listDirectory in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 objects to get listed.

Returns:

the list of all S3 objects represented by S3 object summary that match the prefix in the given bucket.

listDirectory

public List<com.amazonaws.services.s3.model.S3ObjectSummary> listDirectory(S3FileTransferRequestParamsDto params,
                                                                           boolean ignoreZeroByteDirectoryMarkers)

Description copied from interface: S3Service

Lists all S3 objects matching the S3 key prefix in the given bucket (S3 bucket name).

Specified by:

listDirectory in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 objects to get listed.

ignoreZeroByteDirectoryMarkers - specifies whether to ignore 0 byte objects that represent S3 directories.

Returns:

the list of all keys represented by S3 object summary that match the prefix in the given bucket.

listVersions

public List<com.amazonaws.services.s3.model.S3VersionSummary> listVersions(S3FileTransferRequestParamsDto params)

Description copied from interface: S3Service

Lists all S3 versions matching the S3 key prefix in the given bucket (S3 bucket name).

Specified by:

listVersions in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 versions to get listed.

Returns:

the list of all S3 versions that match the prefix in the given bucket

restoreObjects

public void restoreObjects(S3FileTransferRequestParamsDto params,
                           int expirationInDays,
                           String archiveRetrievalOption)

Description copied from interface: S3Service

Requests to restore a list of keys in the specified bucket.

Specified by:

restoreObjects in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and the file list identify the S3 objects to be restored

expirationInDays - the time, in days, between when an object is restored to the bucket and when it expires

archiveRetrievalOption - the archive retrieval option when restoring an archived object

tagObjects

public void tagObjects(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto,
                       S3FileTransferRequestParamsDto s3ObjectTaggerParamsDto,
                       List<com.amazonaws.services.s3.model.S3ObjectSummary> s3ObjectSummaries,
                       com.amazonaws.services.s3.model.Tag tag)

Description copied from interface: S3Service

Tags S3 objects with the specified S3 object tag.

Specified by:

tagObjects in interface S3Service

Parameters:

s3FileTransferRequestParamsDto - the S3 file transfer request parameters. This set of parameters contains the S3 bucket name

s3ObjectTaggerParamsDto - the S3 file transfer request parameters to be used for tagging S3 objects

s3ObjectSummaries - the list of S3 objects to be tagged

tag - the S3 object tag

tagVersions

public void tagVersions(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto,
                        S3FileTransferRequestParamsDto s3ObjectTaggerParamsDto,
                        List<com.amazonaws.services.s3.model.S3VersionSummary> s3VersionSummaries,
                        com.amazonaws.services.s3.model.Tag tag)

Description copied from interface: S3Service

Tags S3 versions with the specified S3 object tag.

Specified by:

tagVersions in interface S3Service

Parameters:

s3FileTransferRequestParamsDto - the S3 file transfer request parameters

s3ObjectTaggerParamsDto - the S3 file transfer request parameters to be used for tagging S3 objects

s3VersionSummaries - the list of S3 versions to be tagged

tag - the S3 object tag

uploadDirectory

public S3FileTransferResultsDto uploadDirectory(S3FileTransferRequestParamsDto params)
                                         throws InterruptedException

Description copied from interface: S3Service

Uploads a local directory of files into S3.

Specified by:

uploadDirectory in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix are for the target of the copy. The local path is the local directory to be copied.

Returns:

the results.

Throws:

InterruptedException - if any problems were encountered.

uploadFile

public S3FileTransferResultsDto uploadFile(S3FileTransferRequestParamsDto params)
                                    throws InterruptedException

Description copied from interface: S3Service

Uploads a local file into S3.

Specified by:

uploadFile in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix are for the target of the copy. The local path is the local file to be copied.

Returns:

the results.

Throws:

InterruptedException - if any problems were encountered.

uploadFileList

public S3FileTransferResultsDto uploadFileList(S3FileTransferRequestParamsDto params)
                                        throws InterruptedException

Description copied from interface: S3Service

Uploads a list of local files into S3.

Specified by:

uploadFileList in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name, S3 key prefix, and the file list (files) are for the target of the copy. The local path and the file list (files) are the local files to be copied. The keys of the files are calculated relative to the common parent directory (local path) and the S3 key prefix.

Returns:

the file transfer results.

Throws:

InterruptedException - if any problems were encountered.

validateGlacierS3FilesRestored

public void validateGlacierS3FilesRestored(S3FileTransferRequestParamsDto params)
                                    throws RuntimeException

Description copied from interface: S3Service

Validates that all specified Glacier storage class files are restored.

Specified by:

validateGlacierS3FilesRestored in interface S3Service

Parameters:

params - the S3 file transfer request parameters. The S3 bucket name and the file list identify the S3 objects to be validated

Throws:

RuntimeException - if file validation fails