updated S3 Java files to adhere to bucket names

Author: scmacdon

javav2/example_code/s3/src/main/java/com/example/s3/AbortMultipartUploadExamples.java

@@ -54,7 +54,7 @@
  */
 
 public class AbortMultipartUploadExamples {
-    static final String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID();
+    static final String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID(); // Change bucket name.
     static final String key = UUID.randomUUID().toString();
     static final String classPathFilePath = "/multipartUploadFiles/s3-userguide.pdf";
     static final String filePath = getFullFilePath(classPathFilePath);
@@ -78,6 +78,12 @@ public static void doAbortIncompleteMultipartUploadsFromList() {
     }
 
     // snippet-start:[s3.java2.abort_upload_from_list]
+    /**
+     * Aborts all incomplete multipart uploads from the specified S3 bucket.
+     * <p>
+     * This method retrieves a list of all incomplete multipart uploads in the specified S3 bucket,
+     * and then aborts each of those uploads.
+     */
     public static void abortIncompleteMultipartUploadsFromList() {
         ListMultipartUploadsRequest listMultipartUploadsRequest = ListMultipartUploadsRequest.builder()
             .bucket(bucketName)

javav2/example_code/s3/src/main/java/com/example/s3/BasicOpsWithChecksums.java

@@ -43,7 +43,7 @@
 // snippet-start:[s3.java2.basicOpsWithChecksums.full]
 public class BasicOpsWithChecksums {
     static final S3Client s3Client = S3Client.create();
-    static final String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID();
+    static final String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID(); // Change bucket name.
     static final String key = UUID.randomUUID().toString();
     private static final Logger logger = LoggerFactory.getLogger(BasicOpsWithChecksums.class);
 

javav2/example_code/s3/src/main/java/com/example/s3/CheckObjectIntegrity.java

@@ -86,6 +86,14 @@ public static void main(String[] args) {
         validateExistingFileAgainstS3Checksum(s3, bucketName, objectKey, objectPath);
     }
 
+    /**
+     * Uploads an object to an Amazon S3 bucket using the Multipart Upload API, with the object being bracketed by a checksum.
+     *
+     * @param s3 The S3Client instance used to interact with the Amazon S3 service.
+     * @param bucketName The name of the S3 bucket to upload the object to.
+     * @param objectKey The key (name) of the object to be uploaded.
+     * @param objectPath The local file path of the object to be uploaded.
+     */
     public static void putS3MultipartObjectBracketedByChecksum(S3Client s3, String bucketName, String objectKey,
                                                                String objectPath) {
         System.out.println("Starting uploading file with additional checksum.");
@@ -137,6 +145,14 @@ public static void putS3MultipartObjectBracketedByChecksum(S3Client s3, String b
         }
     }
 
+    /**
+     * Downloads an S3 object that is split into multiple parts, and verifies the checksum of each part as well as the
+     * overall checksum of the entire object.
+     *
+     * @param s3 the S3 client used for interacting with the S3 service
+     * @param bucketName the name of the S3 bucket where the object is located
+     * @param objectKey the key of the S3 object to be downloaded
+     */
     public static void downloadS3MultipartObjectBracketedByChecksum(S3Client s3, String bucketName,
                                                                     String objectKey) {
         System.out.println("Starting downloading file and doing validation");
@@ -196,6 +212,16 @@ public static void downloadS3MultipartObjectBracketedByChecksum(S3Client s3, Str
         }
     }
 
+    /**
+     * Validates the locally persisted file against the checksum stored in Amazon S3.
+     *
+     * @param s3             The S3Client instance to interact with Amazon S3.
+     * @param bucketName     The name of the S3 bucket where the object is stored.
+     * @param objectKey      The key of the S3 object to be validated.
+     * @param objectPath     The local file path of the object to be validated.
+     * @throws IOException   If there is an error reading the local file or validating the checksum.
+     * @throws NoSuchAlgorithmException If the specified algorithm (SHA-256) is not available.
+     */
     public static void validateExistingFileAgainstS3Checksum(S3Client s3, String bucketName, String objectKey,
                                                              String objectPath) {
         System.out.println("Starting validating the locally persisted file.");

javav2/example_code/s3/src/main/java/com/example/s3/CopyObjectStorage.java

@@ -51,6 +51,14 @@ public static void main(String[] args) {
         s3.close();
     }
 
+    /**
+     * Copies an object from one Amazon S3 bucket to another, and stores the object in the DEEP_ARCHIVE storage class.
+     *
+     * @param s3 the S3Client object used to interact with the Amazon S3 service
+     * @param fromBucket the name of the bucket from which the object is being copied
+     * @param objectKey the name of the object to be copied
+     * @param toBucket the name of the bucket to which the object is being copied
+     */
     public static void copyBucketObject(S3Client s3, String fromBucket, String objectKey, String toBucket) {
         CopyObjectRequest copyReq = CopyObjectRequest.builder()
             .sourceBucket(fromBucket)

javav2/example_code/s3/src/main/java/com/example/s3/CreateAccessPoint.java

@@ -53,7 +53,16 @@ public static void main(String[] args) {
         s3ControlClient.close();
     }
 
-    // This method creates an access point for the given Amazon S3 bucket.
+    /**
+     * Creates a specific access point on an Amazon S3 bucket.
+     *
+     * @param s3ControlClient the S3 Control client to use for the operation
+     * @param accountId the AWS account ID associated with the bucket
+     * @param bucketName the name of the S3 bucket
+     * @param accessPointName the name of the access point to be created
+     *
+     * @throws S3ControlException if there is an error creating the access point
+     */
     public static void createSpecificAccessPoint(S3ControlClient s3ControlClient, String accountId, String bucketName,
                                                  String accessPointName) {
         try {
@@ -72,6 +81,14 @@ public static void createSpecificAccessPoint(S3ControlClient s3ControlClient, St
         }
     }
 
+    /**
+     * Deletes a specific S3 access point.
+     *
+     * @param s3ControlClient the S3 Control client to use for the operation
+     * @param accountId the account ID of the access point to delete
+     * @param accessPointName the name of the access point to delete
+     * @throws S3ControlException if an error occurs while deleting the access point
+     */
     public static void deleteSpecificAccessPoint(S3ControlClient s3ControlClient, String accountId,
                                                  String accessPointName) {
         try {

javav2/example_code/s3/src/main/java/com/example/s3/DeleteBucketPolicy.java

@@ -47,6 +47,14 @@ public static void main(String[] args) {
         s3.close();
     }
 
+    /**
+     * Deletes the S3 bucket policy for the specified bucket.
+     *
+     * @param s3 the {@link S3Client} instance to use for the operation
+     * @param bucketName the name of the S3 bucket for which the policy should be deleted
+     *
+     * @throws S3Exception if there is an error deleting the bucket policy
+     */
     public static void deleteS3BucketPolicy(S3Client s3, String bucketName) {
         DeleteBucketPolicyRequest delReq = DeleteBucketPolicyRequest.builder()
                 .bucket(bucketName)

javav2/example_code/s3/src/main/java/com/example/s3/DeleteMultiObjects.java

@@ -52,6 +52,12 @@ public static void main(String[] args) {
         s3.close();
     }
 
+    /**
+     * Deletes multiple objects from an Amazon S3 bucket.
+     *
+     * @param s3 An Amazon S3 client object.
+     * @param bucketName The name of the Amazon S3 bucket to delete objects from.
+     */
     public static void deleteBucketObjects(S3Client s3, String bucketName) {
         // Upload three sample objects to the specfied Amazon S3 bucket.
         ArrayList<ObjectIdentifier> keys = new ArrayList<>();

javav2/example_code/s3/src/main/java/com/example/s3/DeleteWebsiteConfiguration.java

@@ -48,6 +48,13 @@ public static void main(String[] args) {
         s3.close();
     }
 
+    /**
+     * Deletes the website configuration for an Amazon S3 bucket.
+     *
+     * @param s3 The {@link S3Client} instance used to interact with Amazon S3.
+     * @param bucketName The name of the S3 bucket for which the website configuration should be deleted.
+     * @throws S3Exception If an error occurs while deleting the website configuration.
+     */
     public static void deleteBucketWebsiteConfig(S3Client s3, String bucketName) {
         DeleteBucketWebsiteRequest delReq = DeleteBucketWebsiteRequest.builder()
             .bucket(bucketName)

javav2/example_code/s3/src/main/java/com/example/s3/GeneratePresignedGetUrlAndRetrieve.java

@@ -48,7 +48,7 @@ public class GeneratePresignedGetUrlAndRetrieve {
     private final static S3Client s3Client = S3Client.create();
 
     public static void main(String[] args) {
-        String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID();
+        String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID(); // Change bucket name.
         String keyName = "key" + UUID.randomUUID();
         String resourcePath = "multipartUploadFiles/s3-userguide.pdf";
 

javav2/example_code/s3/src/main/java/com/example/s3/GeneratePresignedUrlAndPutFileWithMetadata.java

@@ -52,7 +52,7 @@ public class GeneratePresignedUrlAndPutFileWithMetadata {
     private final static S3Client s3Client = S3Client.create();
 
     public static void main(String[] args) {
-        String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID();
+        String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID(); // Change bucket name.
         String keyName = "key" + UUID.randomUUID();
         String resourcePath = "multipartUploadFiles/s3-userguide.pdf";
         // Uncomment the following two lines and comment out the previous two lines to use an image file instead of a PDF file.