software.amazon.awssdk.transfer.s3.internal

Class DefaultS3TransferManager

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.DefaultS3TransferManager

All Implemented Interfaces:

AutoCloseable, S3TransferManager, SdkAutoCloseable

public final class DefaultS3TransferManager
extends Object
implements S3TransferManager

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.transfer.s3.S3TransferManager

S3TransferManager.Builder

Constructor Summary

Constructors

Constructor and Description
DefaultS3TransferManager(software.amazon.awssdk.transfer.s3.internal.DefaultS3TransferManager.DefaultBuilder tmBuilder)

Method Summary

Modifier and Type	Method and Description
static S3TransferManager.Builder	builder() Creates a default builder for S3TransferManager.
void	close()
<ResultT> Download<ResultT>	download(DownloadRequest<ResultT> downloadRequest) Download an object identified by the bucket and key from S3 through the given AsyncResponseTransformer.
FileDownload	downloadFile(DownloadFileRequest downloadRequest) Download an object identified by the bucket and key from S3 to a local file.
Upload	upload(UploadRequest uploadRequest) Upload the given AsyncRequestBody to an object in S3.
DirectoryUpload	uploadDirectory(UploadDirectoryRequest uploadDirectoryRequest) Upload all files under the given directory to the provided S3 bucket.
FileUpload	uploadFile(UploadFileRequest uploadFileRequest) Upload a local file to an object in S3.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.transfer.s3.S3TransferManager

create, download, downloadFile, upload, uploadDirectory, uploadFile

Constructor Detail

DefaultS3TransferManager

public DefaultS3TransferManager(software.amazon.awssdk.transfer.s3.internal.DefaultS3TransferManager.DefaultBuilder tmBuilder)

Method Detail

upload

public Upload upload(UploadRequest uploadRequest)

Description copied from interface: S3TransferManager

Upload the given AsyncRequestBody to an object in S3. For file-based uploads, you may use S3TransferManager.uploadFile(UploadFileRequest) instead.

Usage Example:

 
 Upload upload =
     tm.upload(u -> u.requestBody(AsyncRequestBody.fromString("Hello world"))
                     .putObjectRequest(p -> p.bucket("bucket").key("key")));
 // Wait for the transfer to complete
 upload.completionFuture().join();
 
 

See the static factory methods available in AsyncRequestBody for other use cases.

Specified by:

upload in interface S3TransferManager

Parameters:

uploadRequest - the upload request, containing a PutObjectRequest and AsyncRequestBody

Returns:

An Upload that can be used to track the ongoing transfer

See Also:

S3TransferManager.upload(Consumer), S3TransferManager.uploadFile(UploadFileRequest)

uploadFile

public FileUpload uploadFile(UploadFileRequest uploadFileRequest)

Description copied from interface: S3TransferManager

Upload a local file to an object in S3. For non-file-based uploads, you may use S3TransferManager.upload(UploadRequest) instead.

Usage Example:

 
 FileUpload upload =
     tm.uploadFile(u -> u.source(Paths.get("myFile.txt"))
                         .putObjectRequest(p -> p.bucket("bucket").key("key")));
 // Wait for the transfer to complete
 upload.completionFuture().join();
 
 

Specified by:

uploadFile in interface S3TransferManager

See Also:

S3TransferManager.uploadFile(Consumer), S3TransferManager.upload(UploadRequest)

uploadDirectory

public DirectoryUpload uploadDirectory(UploadDirectoryRequest uploadDirectoryRequest)

Description copied from interface: S3TransferManager

Upload all files under the given directory to the provided S3 bucket. The key name transformation depends on the optional prefix and delimiter provided in the UploadDirectoryRequest. By default, all subdirectories will be uploaded recursively, and symbolic links are not followed automatically. This behavior can be configured in UploadDirectoryOverrideConfiguration at request level via UploadDirectoryRequest.Builder.overrideConfiguration(UploadDirectoryOverrideConfiguration) or client level via S3TransferManager.Builder.transferConfiguration(S3TransferManagerOverrideConfiguration) Note that request-level configuration takes precedence over client-level configuration.

The returned CompletableFuture only completes exceptionally if the request cannot be attempted as a whole (the source directory provided does not exist for example). The future completes successfully for partial successful requests, i.e., there might be failed uploads in the successfully completed response. As a result, you should check for errors in the response via CompletedDirectoryUpload.failedTransfers() even when the future completes successfully.

The current user must have read access to all directories and files

Usage Example:

 
 DirectoryUpload directoryUpload =
       transferManager.uploadDirectory(UploadDirectoryRequest.builder()
                                                             .sourceDirectory(Paths.get("."))
                                                             .bucket("bucket")
                                                             .prefix("prefix")
                                                             .build());
 // Wait for the transfer to complete
 CompletedDirectoryUpload completedDirectoryUpload = directoryUpload.completionFuture().join();

 // Print out the failed uploads
 completedDirectoryUpload.failedTransfers().forEach(System.out::println);

 
 

Specified by:

uploadDirectory in interface S3TransferManager

Parameters:

uploadDirectoryRequest - the upload directory request

See Also:

S3TransferManager.uploadDirectory(Consumer), UploadDirectoryOverrideConfiguration

download

public <ResultT> Download<ResultT> download(DownloadRequest<ResultT> downloadRequest)

Description copied from interface: S3TransferManager

Download an object identified by the bucket and key from S3 through the given AsyncResponseTransformer. For downloading to a file, you may use S3TransferManager.downloadFile(DownloadFileRequest) instead.

Usage Example (this example buffers the entire object in memory and is not suitable for large objects):

 
 // Initiate the transfer
 Download<ResponseBytes<GetObjectResponse>> download =
     tm.download(d -> d.getObjectRequest(g -> g.bucket("bucket").key("key"))
                       .responseTransformer(AsyncResponseTransformer.toBytes()));
 // Wait for the transfer to complete
 download.completionFuture().join();
 
 

See the static factory methods available in AsyncResponseTransformer for other use cases.

Specified by:

download in interface S3TransferManager

Type Parameters:

ResultT - The type of data the AsyncResponseTransformer produces

Parameters:

downloadRequest - the download request, containing a GetObjectRequest and AsyncResponseTransformer

Returns:

A Download that can be used to track the ongoing transfer

See Also:

S3TransferManager.download(Function), S3TransferManager.downloadFile(DownloadFileRequest)

downloadFile

public FileDownload downloadFile(DownloadFileRequest downloadRequest)

Description copied from interface: S3TransferManager

Download an object identified by the bucket and key from S3 to a local file. For non-file-based downloads, you may use S3TransferManager.download(DownloadRequest) instead.

Usage Example:

 
 // Initiate the transfer
 FileDownload download =
     tm.downloadFile(d -> d.getObjectRequest(g -> g.bucket("bucket").key("key"))
                           .destination(Paths.get("myFile.txt")));
 // Wait for the transfer to complete
 download.completionFuture().join();
 
 

Specified by:

downloadFile in interface S3TransferManager

See Also:

S3TransferManager.downloadFile(Consumer), S3TransferManager.download(DownloadRequest)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

builder

public static S3TransferManager.Builder builder()

Description copied from interface: S3TransferManager

Creates a default builder for S3TransferManager.

Specified by:

builder in interface S3TransferManager