S3Operations (herd docs javadoc 0.38.0 API)

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

All Methods Instance Methods Abstract Methods
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)`
`com.amazonaws.services.s3.transfer.MultipleFileDownload`	`downloadDirectory(String bucketName, String keyPrefix, File destinationDirectory, com.amazonaws.services.s3.transfer.TransferManager transferManager)` Downloads a directory.
`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()` Rolls back any updates to S3 within a given session.
`com.amazonaws.services.s3.transfer.Upload`	`upload(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest, com.amazonaws.services.s3.transfer.TransferManager transferManager)` Uploads a single file.
`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)` Uploads a directory.
`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)`

Field Detail
- 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
- 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

Method Detail

getObjectMetadata

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

Get the S3 object meta data.

copyFile

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.

restoreObject
```
void restoreObject(com.amazonaws.services.s3.model.RestoreObjectRequest requestRestore,
                   com.amazonaws.services.s3.AmazonS3Client s3Client)
            throws com.amazonaws.AmazonClientException
```
Requests to restore a key in the specified bucket.

Parameters:

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

s3Client - the AmazonS3 implementation to use

Throws:

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

listMultipartUploads

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

Lists multipart uploads.

abortMultipartUpload

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

Aborts the specified multipart upload.

deleteObjects

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

Delete the objects.

listObjects

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

List the objects.

Returns:: object listing.

listVersions

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

List the versions.

Returns:: version listing.

putObject

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

Put an object.

uploadDirectory

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)

Uploads a directory.

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.

uploadFileList

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)

downloadDirectory

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

Downloads a directory.

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

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

Uploads a single file.

Parameters:: putObjectRequest - the put object request.; transferManager - the transfer manager.
Returns:: the upload information.
Throws:: com.amazonaws.AmazonClientException - if an Amazon client exception occurs

download

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

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

getS3Object

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

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

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.

Interface S3Operations

Field Summary

Method Summary

Field Detail

ERROR_CODE_NO_SUCH_BUCKET

ERROR_CODE_NO_SUCH_KEY

ERROR_CODE_ACCESS_DENIED

ERROR_CODE_INTERNAL_ERROR