S3Service (herd docs javadoc 0.96.0 API)

All Known Implementing Classes:

S3ServiceImpl
```
public interface S3Service
```
A service for Amazon AWS S3.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`S3FileTransferResultsDto`	`copyFile(S3FileCopyRequestParamsDto s3FileCopyRequestParamsDto)` Copies an S3 object from the source S3 bucket to the same path in target bucket.
`void`	`createDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Creates an S3 object of 0 byte size that represents a directory.
`void`	`deleteDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Deletes keys/key versions from specified bucket with matching prefix.
`void`	`deleteDirectoryIgnoreException(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Deletes keys/objects from specified bucket with matching prefix.
`void`	`deleteFileList(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Deletes a list of keys from specified bucket.
`S3FileTransferResultsDto`	`downloadDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Downloads a directory from S3 to the local file system.
`S3FileTransferResultsDto`	`downloadFile(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Downloads a file from S3 to the local file system.
`List<com.amazonaws.services.s3.model.S3ObjectSummary>`	`listDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` 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 s3FileTransferRequestParamsDto, 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 s3FileTransferRequestParamsDto)` Lists all S3 versions matching the S3 key prefix in the given bucket (S3 bucket name).
`void`	`restoreObjects(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto, 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 s3FileTransferRequestParamsDto)` Uploads a local directory of files into S3.
`S3FileTransferResultsDto`	`uploadFile(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Uploads a local file into S3.
`S3FileTransferResultsDto`	`uploadFileList(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Uploads a list of local files into S3.
`void`	`validateGlacierS3FilesRestored(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)` Validates that all specified Glacier storage class files are restored.

- Method Detail
  - copyFile
```
S3FileTransferResultsDto copyFile(S3FileCopyRequestParamsDto s3FileCopyRequestParamsDto)
                           throws InterruptedException
```
    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.
    
    Parameters:
    
    s3FileCopyRequestParamsDto - the S3 file copy request parameters.
    
    Returns:
    
    the results.
    
    Throws:
    
    InterruptedException - if any problems were encountered.
  - createDirectory
```
void createDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
```
    Creates an S3 object of 0 byte size that represents a directory.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 object to be created.
  - deleteDirectory
```
void deleteDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
```
    Deletes keys/key versions from specified bucket with matching prefix.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 objects to be deleted.
  - deleteDirectoryIgnoreException
```
void deleteDirectoryIgnoreException(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
```
    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.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - the S3 file transfer request parameters. The S3 bucket name and S3 key prefix identify the S3 objects to be deleted.
  - deleteFileList
```
void deleteFileList(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
```
    Deletes a list of keys from specified bucket.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - the S3 file transfer request parameters. The S3 bucket name and the file list identify the S3 objects to be deleted.
  - downloadDirectory
```
S3FileTransferResultsDto downloadDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
                                    throws InterruptedException
```
    Downloads a directory from S3 to the local file system.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
S3FileTransferResultsDto downloadFile(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
                               throws InterruptedException
```
    Downloads a file from S3 to the local file system.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
List<com.amazonaws.services.s3.model.S3ObjectSummary> listDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
```
    Lists all S3 objects matching the S3 key prefix in the given bucket (S3 bucket name).
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
List<com.amazonaws.services.s3.model.S3ObjectSummary> listDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto,
                                                                    boolean ignoreZeroByteDirectoryMarkers)
```
    Lists all S3 objects matching the S3 key prefix in the given bucket (S3 bucket name).
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
List<com.amazonaws.services.s3.model.S3VersionSummary> listVersions(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
```
    Lists all S3 versions matching the S3 key prefix in the given bucket (S3 bucket name).
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
void restoreObjects(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto,
                    int expirationInDays,
                    String archiveRetrievalOption)
```
    Requests to restore a list of keys in the specified bucket.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
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.
    
    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
```
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.
    
    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
```
S3FileTransferResultsDto uploadDirectory(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
                                  throws InterruptedException
```
    Uploads a local directory of files into S3.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
S3FileTransferResultsDto uploadFile(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
                             throws InterruptedException
```
    Uploads a local file into S3.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
S3FileTransferResultsDto uploadFileList(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
                                 throws InterruptedException
```
    Uploads a list of local files into S3.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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
```
void validateGlacierS3FilesRestored(S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto)
                             throws RuntimeException
```
    Validates that all specified Glacier storage class files are restored.
    
    Parameters:
    
    s3FileTransferRequestParamsDto - 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

Interface S3Service

Method Summary

Method Detail

copyFile

createDirectory

deleteDirectory

deleteDirectoryIgnoreException

deleteFileList

downloadDirectory

downloadFile

listDirectory

listDirectory

listVersions

restoreObjects

tagObjects

tagVersions

uploadDirectory

uploadFile

uploadFileList

validateGlacierS3FilesRestored