S3DaoImpl (herd docs javadoc 0.148.0 API)

java.lang.Object
- org.finra.herd.dao.impl.S3DaoImpl

All Implemented Interfaces:: S3Dao

@Repository
public class S3DaoImpl
extends Object
implements S3Dao

The S3 DAO implementation.

Field Summary
- Fields inherited from interface org.finra.herd.dao.S3Dao
  SIGNER_OVERRIDE_V4

Constructor Summary

Constructors
Constructor and Description

S3DaoImpl()

Constructors
Constructor and Description
`S3DaoImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`abortMultipartUploads(S3FileTransferRequestParamsDto params, Date thresholdDate)` Aborts any multipart uploads that were initiated in the specified S3 storage older than threshold date.
`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`	`createEmptyDirectory(S3FileTransferRequestParamsDto params)` Creates an S3 object of 0 byte size that represents an empty directory.
`void`	`deleteDirectory(S3FileTransferRequestParamsDto params)` Deletes keys/key versions 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.
`String`	`generateGetObjectPresignedUrl(String bucketName, String key, Date expiration, S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Generates a GET pre-signed URL for the given object in S3 identified by its bucket name and key.
`com.amazonaws.services.s3.model.ObjectMetadata`	`getObjectMetadata(S3FileTransferRequestParamsDto params)` Gets the metadata for the specified Amazon S3 object without actually fetching the object itself.
`Properties`	`getProperties(String bucketName, String key, S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Gets an object from S3 and parses it as a `Properties`.
`protected boolean`	`isRootKeyPrefix(String s3KeyPrefix)` Returns true is S3 key prefix is a root.
`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.
`boolean`	`s3FileExists(S3FileTransferRequestParamsDto params)` Validates that file exists in S3 using S3Client.getObject() method.
`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.
`void`	`validateS3File(S3FileTransferRequestParamsDto params, Long fileSizeInBytes)` Validates that file exists in S3 and has size that equals to a specified value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - S3DaoImpl
```
public S3DaoImpl()
```
- Method Detail
  - abortMultipartUploads
```
public int abortMultipartUploads(S3FileTransferRequestParamsDto params,
                                 Date thresholdDate)
```
    Description copied from interface: S3Dao
    
    Aborts any multipart uploads that were initiated in the specified S3 storage older than threshold date.
    
    Specified by:
    
    abortMultipartUploads in interface S3Dao
    
    Parameters:
    
    params - the S3 file transfer request parameters. The S3 bucket name specifies the name of the bucket containing the multipart uploads to abort.
    
    thresholdDate - the date indicating which multipart uploads should be aborted
    
    Returns:
    
    the total number of aborted multipart uploads
  - copyFile
```
public S3FileTransferResultsDto copyFile(S3FileCopyRequestParamsDto params)
                                  throws InterruptedException
```
    Description copied from interface: S3Dao
    
    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 S3Dao
    
    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: S3Dao
    
    Creates an S3 object of 0 byte size that represents a directory.
    
    Specified by:
    
    createDirectory in interface S3Dao
    
    Parameters:
    
    params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 object to be created.
  - createEmptyDirectory
```
public void createEmptyDirectory(S3FileTransferRequestParamsDto params)
```
    Description copied from interface: S3Dao
    
    Creates an S3 object of 0 byte size that represents an empty directory.
    
    Specified by:
    
    createEmptyDirectory in interface S3Dao
    
    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: S3Dao
    
    Deletes keys/key versions from specified bucket with matching prefix.
    
    Specified by:
    
    deleteDirectory in interface S3Dao
    
    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: S3Dao
    
    Deletes a list of keys from specified bucket.
    
    Specified by:
    
    deleteFileList in interface S3Dao
    
    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: S3Dao
    
    Downloads a directory from S3 to the local file system.
    
    Specified by:
    
    downloadDirectory in interface S3Dao
    
    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.
  - downloadFile
```
public S3FileTransferResultsDto downloadFile(S3FileTransferRequestParamsDto params)
                                      throws InterruptedException
```
    Description copied from interface: S3Dao
    
    Downloads a file from S3 to the local file system.
    
    Specified by:
    
    downloadFile in interface S3Dao
    
    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.
  - generateGetObjectPresignedUrl
```
public String generateGetObjectPresignedUrl(String bucketName,
                                            String key,
                                            Date expiration,
                                            S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
```
    Description copied from interface: S3Dao
    
    Generates a GET pre-signed URL for the given object in S3 identified by its bucket name and key. Uses the proxy information and signer override specified in the given S3FileTransferRequestParamsDto.
    
    Specified by:
    
    generateGetObjectPresignedUrl in interface S3Dao
    
    Parameters:
    
    bucketName - The bucket name of the object
    
    key - The S3 key to the object
    
    expiration - The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.
    
    s3FileTransferRequestParamsDto - The parameters which contain information on how to use S3
    
    Returns:
    
    a pre-signed URL
  - getObjectMetadata
```
public com.amazonaws.services.s3.model.ObjectMetadata getObjectMetadata(S3FileTransferRequestParamsDto params)
```
    Description copied from interface: S3Dao
    
    Gets the metadata for the specified Amazon S3 object without actually fetching the object itself.
    
    Specified by:
    
    getObjectMetadata in interface S3Dao
    
    Parameters:
    
    params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 object's whose metadata is being retrieved.
    
    Returns:
    
    null if object key is not found, otherwise all Amazon S3 object metadata for the specified object
  - getProperties
```
public Properties getProperties(String bucketName,
                                String key,
                                S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
```
    Description copied from interface: S3Dao
    
    Gets an object from S3 and parses it as a Properties.
    
    Specified by:
    
    getProperties in interface S3Dao
    
    Parameters:
    
    bucketName - The S3 bucket name
    
    key - The S3 object key
    
    s3FileTransferRequestParamsDto - S3FileTransferRequestParamsDto with proxy information
    
    Returns:
    
    Properties
  - listDirectory
```
public List<com.amazonaws.services.s3.model.S3ObjectSummary> listDirectory(S3FileTransferRequestParamsDto params)
```
    Description copied from interface: S3Dao
    
    Lists all S3 objects matching the S3 key prefix in the given bucket (S3 bucket name).
    
    Specified by:
    
    listDirectory in interface S3Dao
    
    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 summaries 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: S3Dao
    
    Lists all S3 objects matching the S3 key prefix in the given bucket (S3 bucket name).
    
    Specified by:
    
    listDirectory in interface S3Dao
    
    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 S3 objects represented by S3 object summaries that match the prefix in the given bucket.
  - listVersions
```
public List<com.amazonaws.services.s3.model.S3VersionSummary> listVersions(S3FileTransferRequestParamsDto params)
```
    Description copied from interface: S3Dao
    
    Lists all S3 versions matching the S3 key prefix in the given bucket (S3 bucket name). The S3 bucket name and S3 key prefix that identify the S3 versions to get listed are taken from the S3 file transfer request parameters DTO.
    
    Specified by:
    
    listVersions in interface S3Dao
    
    Parameters:
    
    params - the S3 file transfer request parameters
    
    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: S3Dao
    
    Requests to restore a list of keys in the specified bucket.
    
    Specified by:
    
    restoreObjects in interface S3Dao
    
    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
  - s3FileExists
```
public boolean s3FileExists(S3FileTransferRequestParamsDto params)
                     throws RuntimeException
```
    Description copied from interface: S3Dao
    
    Validates that file exists in S3 using S3Client.getObject() method.
    
    Specified by:
    
    s3FileExists in interface S3Dao
    
    Parameters:
    
    params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 file
    
    Returns:
    
    true if the S3 file exists, false otherwise
    
    Throws:
    
    RuntimeException - if file existence check fails
  - 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: S3Dao
    
    Tags S3 objects with the specified S3 object tag.
    
    Specified by:
    
    tagObjects in interface S3Dao
    
    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: S3Dao
    
    Tags S3 versions with the specified S3 object tag.
    
    Specified by:
    
    tagVersions in interface S3Dao
    
    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
    
    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: S3Dao
    
    Uploads a local directory of files into S3.
    
    Specified by:
    
    uploadDirectory in interface S3Dao
    
    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.
  - uploadFile
```
public S3FileTransferResultsDto uploadFile(S3FileTransferRequestParamsDto params)
                                    throws InterruptedException
```
    Description copied from interface: S3Dao
    
    Uploads a local file into S3.
    
    Specified by:
    
    uploadFile in interface S3Dao
    
    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 file transfer results.
    
    Throws:
    
    InterruptedException - if any problems were encountered.
  - uploadFileList
```
public S3FileTransferResultsDto uploadFileList(S3FileTransferRequestParamsDto params)
                                        throws InterruptedException
```
    Description copied from interface: S3Dao
    
    Uploads a list of local files into S3.
    
    Specified by:
    
    uploadFileList in interface S3Dao
    
    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: S3Dao
    
    Validates that all specified Glacier storage class files are restored.
    
    Specified by:
    
    validateGlacierS3FilesRestored in interface S3Dao
    
    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
  - validateS3File
```
public void validateS3File(S3FileTransferRequestParamsDto params,
                           Long fileSizeInBytes)
                    throws RuntimeException
```
    Description copied from interface: S3Dao
    
    Validates that file exists in S3 and has size that equals to a specified value.
    
    Specified by:
    
    validateS3File in interface S3Dao
    
    Parameters:
    
    params - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 file.
    
    fileSizeInBytes - the expected file size in bytes
    
    Throws:
    
    RuntimeException - if file validation fails
  - isRootKeyPrefix
```
protected boolean isRootKeyPrefix(String s3KeyPrefix)
```
    Returns true is S3 key prefix is a root.
    
    Parameters:
    
    s3KeyPrefix - the S3 key prefix to be validated
    
    Returns:
    
    true if S3 key prefix is a root; false otherwise

Class S3DaoImpl

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3DaoImpl

Method Detail

abortMultipartUploads

copyFile

createDirectory

createEmptyDirectory

deleteDirectory

deleteFileList

downloadDirectory

downloadFile

generateGetObjectPresignedUrl

getObjectMetadata

getProperties

listDirectory

listDirectory

listVersions

restoreObjects

s3FileExists

tagObjects

tagVersions

uploadDirectory

uploadFile

uploadFileList

validateGlacierS3FilesRestored

validateS3File

isRootKeyPrefix