Skip to content

Commit 7ea7151

Browse files
adding snippets to S3 transferManager exeamples
1 parent 560362f commit 7ea7151

File tree

4 files changed

+36
-0
lines changed

4 files changed

+36
-0
lines changed

java/example_code/s3/src/main/java/aws/example/s3/XferMgrCopy.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,15 @@
2424
specific language governing permissions and limitations under the License.
2525
*/
2626
package aws.example.s3;
27+
// snippet-start:[s3.java1.s3_xfer_mgr_copy.import]
2728
import aws.example.s3.XferMgrProgress;
2829
import com.amazonaws.AmazonServiceException;
2930
import com.amazonaws.services.s3.transfer.Copy;
3031
import com.amazonaws.services.s3.transfer.TransferManager;
3132
import com.amazonaws.services.s3.transfer.TransferManagerBuilder;
33+
// snippet-end:[s3.java1.s3_xfer_mgr_copy.import]
3234

35+
// snippet-start:[s3.java1.s3_xfer_mgr_copy.complete]
3336
/**
3437
* Copy an object from one Amazon S3 bucket to another using S3 TransferManager.
3538
*
@@ -40,6 +43,7 @@ public class XferMgrCopy
4043
{
4144
public static void copyObjectSimple(String from_bucket, String from_key,
4245
String to_bucket, String to_key) {
46+
// snippet-start:[s3.java1.s3_xfer_mgr_copy.copy_object]
4347
System.out.println("Copying s3 object: " + from_key);
4448
System.out.println(" from bucket: " + from_bucket);
4549
System.out.println(" to s3 object: " + to_key);
@@ -57,6 +61,7 @@ public static void copyObjectSimple(String from_bucket, String from_key,
5761
System.exit(1);
5862
}
5963
xfer_mgr.shutdownNow();
64+
// snippet-end:[s3.java1.s3_xfer_mgr_copy.copy_object]
6065
}
6166

6267
public static void main(String[] args)
@@ -96,3 +101,4 @@ public static void main(String[] args)
96101
}
97102
}
98103
}
104+
// snippet-end:[s3.java1.s3_xfer_mgr_copy.complete]

java/example_code/s3/src/main/java/aws/example/s3/XferMgrDownload.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,17 @@
2121
specific language governing permissions and limitations under the License.
2222
*/
2323
package aws.example.s3;
24+
// snippet-start:[s3.java1.s3_xfer_mgr_download.import]
2425
import aws.example.s3.XferMgrProgress;
2526
import com.amazonaws.AmazonServiceException;
2627
import com.amazonaws.services.s3.transfer.TransferManager;
2728
import com.amazonaws.services.s3.transfer.TransferManagerBuilder;
2829
import com.amazonaws.services.s3.transfer.Download;
2930
import com.amazonaws.services.s3.transfer.MultipleFileDownload;
3031
import java.io.File;
32+
// snippet-end:[s3.java1.s3_xfer_mgr_download.import]
3133

34+
// snippet-start:[s3.java1.s3_xfer_mgr_download.complete]
3235
/**
3336
* Download objects from an Amazon S3 bucket using S3 TransferManager.
3437
*
@@ -43,6 +46,7 @@ public static void downloadDir(String bucket_name, String key_prefix,
4346
System.out.println("downloading to directory: " + dir_path +
4447
(pause ? " (pause)" : ""));
4548

49+
// snippet-start:[s3.java1.s3_xfer_mgr_download.directory]
4650
TransferManager xfer_mgr = TransferManagerBuilder.standard().build();
4751

4852
try {
@@ -57,6 +61,7 @@ public static void downloadDir(String bucket_name, String key_prefix,
5761
System.exit(1);
5862
}
5963
xfer_mgr.shutdownNow();
64+
// snippet-end:[s3.java1.s3_xfer_mgr_download.directory]
6065
}
6166

6267
public static void downloadFile(String bucket_name, String key_name,
@@ -65,6 +70,7 @@ public static void downloadFile(String bucket_name, String key_name,
6570
System.out.println("Downloading to file: " + file_path +
6671
(pause ? " (pause)" : ""));
6772

73+
// snippet-start:[s3.java1.s3_xfer_mgr_download.single]
6874
File f = new File(file_path);
6975
TransferManager xfer_mgr = TransferManagerBuilder.standard().build();
7076
try {
@@ -78,6 +84,7 @@ public static void downloadFile(String bucket_name, String key_name,
7884
System.exit(1);
7985
}
8086
xfer_mgr.shutdownNow();
87+
// snippet-end:[s3.java1.s3_xfer_mgr_download.single]
8188
}
8289

8390
public static void main(String[] args)
@@ -181,3 +188,4 @@ public static void main(String[] args)
181188
}
182189
}
183190
}
191+
// snippet-end:[s3.java1.s3_xfer_mgr_download.complete]

java/example_code/s3/src/main/java/aws/example/s3/XferMgrProgress.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
specific language governing permissions and limitations under the License.
2323
*/
2424
package aws.example.s3;
25+
// snippet-start:[s3.java1.s3_xfer_mgr_progress.import]
2526
import com.amazonaws.AmazonClientException;
2627
import com.amazonaws.AmazonServiceException;
2728
import com.amazonaws.event.ProgressEvent;
@@ -36,12 +37,15 @@
3637
import java.io.File;
3738
import java.util.ArrayList;
3839
import java.util.Collection;
40+
// snippet-end:[s3.java1.s3_xfer_mgr_progress.import]
3941

42+
// snippet-start:[s3.java1.s3_xfer_mgr_progress.complete]
4043
public class XferMgrProgress
4144
{
4245
// waits for the transfer to complete, catching any exceptions that occur.
4346
public static void waitForCompletion(Transfer xfer)
4447
{
48+
// snippet-start:[s3.java1.s3_xfer_mgr_progress.wait_for_transfer]
4549
try {
4650
xfer.waitForCompletion();
4751
} catch (AmazonServiceException e) {
@@ -54,11 +58,13 @@ public static void waitForCompletion(Transfer xfer)
5458
System.err.println("Transfer interrupted: " + e.getMessage());
5559
System.exit(1);
5660
}
61+
// snippet-end:[s3.java1.s3_xfer_mgr_progress.wait_for_transfer]
5762
}
5863

5964
// Prints progress while waiting for the transfer to finish.
6065
public static void showTransferProgress(Transfer xfer)
6166
{
67+
// snippet-start:[s3.java1.s3_xfer_mgr_progress.poll]
6268
// print the transfer's human-readable description
6369
System.out.println(xfer.getDescription());
6470
// print an empty progress bar...
@@ -82,6 +88,7 @@ public static void showTransferProgress(Transfer xfer)
8288
// print the final state of the transfer.
8389
TransferState xfer_state = xfer.getState();
8490
System.out.println(": " + xfer_state);
91+
// snippet-end:[s3.java1.s3_xfer_mgr_progress.poll]
8592
}
8693

8794
// Prints progress of a multiple file upload while waiting for it to finish.
@@ -90,6 +97,7 @@ public static void showMultiUploadProgress(MultipleFileUpload multi_upload)
9097
// print the upload's human-readable description
9198
System.out.println(multi_upload.getDescription());
9299

100+
// snippet-start:[s3.java1.s3_xfer_mgr_progress.substranferes]
93101
Collection<? extends Upload> sub_xfers = new ArrayList<Upload>();
94102
sub_xfers = multi_upload.getSubTransfers();
95103

@@ -118,6 +126,7 @@ public static void showMultiUploadProgress(MultipleFileUpload multi_upload)
118126
// print the final state of the transfer.
119127
TransferState xfer_state = multi_upload.getState();
120128
System.out.println("\nMultipleFileUpload " + xfer_state);
129+
// snippet-end:[s3.java1.s3_xfer_mgr_progress.substranferes]
121130
}
122131

123132
// prints a simple text progressbar: [##### ]
@@ -154,6 +163,7 @@ public static void uploadFileWithListener(String file_path,
154163
key_name = file_path;
155164
}
156165

166+
// snippet-start:[s3.java1.s3_xfer_mgr_progress.progress_listener]
157167
File f = new File(file_path);
158168
TransferManager xfer_mgr = TransferManagerBuilder.standard().build();
159169
try {
@@ -177,6 +187,7 @@ public void progressChanged(ProgressEvent e) {
177187
System.exit(1);
178188
}
179189
xfer_mgr.shutdownNow();
190+
// snippet-end:[s3.java1.s3_xfer_mgr_progress.progress_listener]
180191
}
181192

182193
public static void uploadDirWithSubprogress(String dir_path,
@@ -268,3 +279,4 @@ else if (f.isDirectory()) {
268279
}
269280
}
270281
}
282+
// snippet-end:[s3.java1.s3_xfer_mgr_progress.complete]

java/example_code/s3/src/main/java/aws/example/s3/XferMgrUpload.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
specific language governing permissions and limitations under the License.
2323
*/
2424
package aws.example.s3;
25+
// snippet-start:[s3.java1.s3_xfer_mgr_upload.import]
2526
import aws.example.s3.XferMgrProgress;
2627
import com.amazonaws.AmazonServiceException;
2728
import com.amazonaws.services.s3.transfer.TransferManager;
@@ -31,7 +32,9 @@
3132
import java.io.File;
3233
import java.util.ArrayList;
3334
import java.util.Arrays;
35+
// snippet-end:[s3.java1.s3_xfer_mgr_upload.import]
3436

37+
// snippet-start:[s3.java1.s3_xfer_mgr_upload.complete]
3538
/**
3639
* Upload objects to an Amazon S3 bucket using S3 TransferManager.
3740
*
@@ -46,6 +49,7 @@ public static void uploadDir(String dir_path, String bucket_name,
4649
System.out.println("directory: " + dir_path + (recursive ?
4750
" (recursive)" : "") + (pause ? " (pause)" : ""));
4851

52+
// snippet-start:[s3.java1.s3_xfer_mgr_upload.directory]
4953
TransferManager xfer_mgr = TransferManagerBuilder.standard().build();
5054
try {
5155
MultipleFileUpload xfer = xfer_mgr.uploadDirectory(bucket_name,
@@ -59,6 +63,7 @@ public static void uploadDir(String dir_path, String bucket_name,
5963
System.exit(1);
6064
}
6165
xfer_mgr.shutdownNow();
66+
// snippet-end:[s3.java1.s3_xfer_mgr_upload.directory]
6267
}
6368

6469
public static void uploadFileList(String[] file_paths, String bucket_name,
@@ -68,6 +73,7 @@ public static void uploadFileList(String[] file_paths, String bucket_name,
6873
(pause ? " (pause)" : ""));
6974
// convert the file paths to a list of File objects (required by the
7075
// uploadFileList method)
76+
// snippet-start:[s3.java1.s3_xfer_mgr_upload.list_of_files]
7177
ArrayList<File> files = new ArrayList<File>();
7278
for (String path : file_paths) {
7379
files.add(new File(path));
@@ -86,6 +92,7 @@ public static void uploadFileList(String[] file_paths, String bucket_name,
8692
System.exit(1);
8793
}
8894
xfer_mgr.shutdownNow();
95+
// snippet-end:[s3.java1.s3_xfer_mgr_upload.list_of_files]
8996
}
9097

9198
public static void uploadFile(String file_path, String bucket_name,
@@ -101,6 +108,7 @@ public static void uploadFile(String file_path, String bucket_name,
101108
key_name = file_path;
102109
}
103110

111+
// snippet-start:[s3.java1.s3_xfer_mgr_upload.single]
104112
File f = new File(file_path);
105113
TransferManager xfer_mgr = TransferManagerBuilder.standard().build();
106114
try {
@@ -114,6 +122,7 @@ public static void uploadFile(String file_path, String bucket_name,
114122
System.exit(1);
115123
}
116124
xfer_mgr.shutdownNow();
125+
// snippet-end:[s3.java1.s3_xfer_mgr_upload.single]
117126
}
118127

119128
public static void main(String[] args)
@@ -204,3 +213,4 @@ else if (f.isDirectory()) {
204213
} // else: nothing to do.
205214
}
206215
}
216+
// snippet-end:[s3.java1.s3_xfer_mgr_upload.complete]

0 commit comments

Comments
 (0)