Remove the option to pass bucket and key to DownloadRequest and UploadRequest and remove unused files

Author: zoewangg

services-custom/s3-transfer-manager/pom.xml

@@ -163,8 +163,7 @@
                 <configuration>
                     <archive>
                         <manifestEntries>
-                            <!-- TODO is this a good name? -->
-                            <Automatic-Module-Name>software.amazon.awssdk.custom.s3.transfer</Automatic-Module-Name>
+                            <Automatic-Module-Name>software.amazon.awssdk.transfer.s3</Automatic-Module-Name>
                         </manifestEntries>
                     </archive>
                 </configuration>

services-custom/s3-transfer-manager/src/it/java/software/amazon/awssdk/transfer/s3/S3TransferManagerDownloadIntegrationTest.java

@@ -58,7 +58,8 @@ public static void cleanup() {
     @Test
     public void download_shouldWork() throws IOException {
         Path path = RandomTempFile.randomUncreatedFile().toPath();
-        Download download = transferManager.download(b -> b.bucket(BUCKET).key(KEY).destination(path));
+        Download download = transferManager.download(b -> b.getObjectRequest(r -> r.bucket(BUCKET).key(KEY))
+                                                           .destination(path));
         CompletedDownload completedDownload = download.completionFuture().join();
         assertThat(Md5Utils.md5AsBase64(path.toFile())).isEqualTo(Md5Utils.md5AsBase64(file));
         assertThat(completedDownload.response().responseMetadata().requestId()).isNotNull();

services-custom/s3-transfer-manager/src/it/java/software/amazon/awssdk/transfer/s3/S3TransferManagerUploadIntegrationTest.java

@@ -61,10 +61,9 @@ public static void teardown() throws IOException {
     @Test
     public void upload_fileSentCorrectly() throws IOException {
         Upload upload = tm.upload(UploadRequest.builder()
-                .bucket(TEST_BUCKET)
-                .key(TEST_KEY)
-                .source(testFile.toPath())
-                .build());
+                                               .putObjectRequest(b -> b.bucket(TEST_BUCKET).key(TEST_KEY))
+                                               .source(testFile.toPath())
+                                               .build());
 
         upload.completionFuture().join();
 

services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/CompletedUploadDirectory.java

@@ -16,6 +16,9 @@
 package software.amazon.awssdk.transfer.s3;
 
 import java.nio.file.Path;
+import java.util.Objects;
+import java.util.function.Consumer;
+import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.services.s3.model.GetObjectRequest;
 import software.amazon.awssdk.utils.Validate;
@@ -31,17 +34,14 @@ public final class DownloadRequest implements TransferRequest, ToCopyableBuilder
     private final GetObjectRequest getObjectRequest;
 
     private DownloadRequest(BuilderImpl builder) {
-        Validate.isTrue((builder.bucket != null && builder.key != null) ^ builder.getObjectRequest != null,
-                        "Exactly one of a bucket, key pair or API request must be provided.");
         this.destination = Validate.paramNotNull(builder.destination, "destination");
-        this.getObjectRequest = builder.getObjectRequest == null ? GetObjectRequest.builder()
-                                                                                   .bucket(builder.bucket)
-                                                                                   .key(builder.key)
-                                                                                   .build() : builder.getObjectRequest;
+        this.getObjectRequest = Validate.paramNotNull(builder.getObjectRequest, "getObjectRequest");
     }
 
     /**
-     * @return A builder for this request.
+     * Create a builder that can be used to create a {@link DownloadRequest}.
+     *
+     * @see S3TransferManager#download(DownloadRequest)
      */
     public static Builder builder() {
         return new BuilderImpl();
@@ -52,16 +52,6 @@ public Builder toBuilder() {
         return new BuilderImpl();
     }
 
-    @Override
-    public String bucket() {
-        return getObjectRequest.bucket();
-    }
-
-    @Override
-    public String key() {
-        return getObjectRequest.key();
-    }
-
     /**
      * The {@link Path} to file that response contents will be written to. The file must not exist or this method
      * will throw an exception. If the file is not writable by the current user then an exception will be thrown.
@@ -72,10 +62,42 @@ public Path destination() {
         return destination;
     }
 
-    public GetObjectRequest toGetObjectRequest() {
+    /**
+     * @return The {@link GetObjectRequest} request that should be used for the download
+     */
+    public GetObjectRequest getObjectRequest() {
         return getObjectRequest;
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+
+        DownloadRequest that = (DownloadRequest) o;
+
+        if (!Objects.equals(destination, that.destination)) {
+            return false;
+        }
+        return Objects.equals(getObjectRequest, that.getObjectRequest);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = destination != null ? destination.hashCode() : 0;
+        result = 31 * result + (getObjectRequest != null ? getObjectRequest.hashCode() : 0);
+        return result;
+    }
+
+    /**
+     * A builder for a {@link DownloadRequest}, created with {@link #builder()}
+     */
+    @SdkPublicApi
+    @NotThreadSafe
     public interface Builder extends TransferRequest.Builder<DownloadRequest, Builder>, CopyableBuilder<Builder,
         DownloadRequest> {
 
@@ -96,15 +118,28 @@ public interface Builder extends TransferRequest.Builder<DownloadRequest, Builde
          */
         Builder getObjectRequest(GetObjectRequest getObjectRequest);
 
+        /**
+         * The {@link GetObjectRequest} request that should be used for the download
+         *
+         * @param getObjectRequestBuilder the getObject request
+         * @return a reference to this object so that method calls can be chained together.
+         */
+        default Builder getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder) {
+            GetObjectRequest request = GetObjectRequest.builder()
+                                                       .applyMutation(getObjectRequestBuilder)
+                                                       .build();
+            getObjectRequest(request);
+            return this;
+        }
+
+
         /**
          * @return The built request.
          */
         DownloadRequest build();
     }
 
     private static final class BuilderImpl implements Builder {
-        private String bucket;
-        private String key;
         private Path destination;
         private GetObjectRequest getObjectRequest;
 
@@ -117,18 +152,6 @@ public Builder destination(Path destination) {
             return this;
         }
 
-        @Override
-        public Builder bucket(String bucket) {
-            this.bucket = bucket;
-            return this;
-        }
-
-        @Override
-        public Builder key(String key) {
-            this.key = key;
-            return this;
-        }
-
         @Override
         public Builder getObjectRequest(GetObjectRequest getObjectRequest) {
             this.getObjectRequest = getObjectRequest;

services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/DownloadDirectory.java

@@ -23,36 +23,8 @@
 @SdkPublicApi
 public interface TransferRequest {
 
-    /**
-     * The bucket name containing the object.
-     *
-     * @return the bucket name
-     */
-    String bucket();
-
-    /**
-     * The Key of the object.
-     *
-     * @return the key of the object
-     */
-    String key();
-
     interface Builder<TypeToBuildT, BuilderT extends Builder> {
 
-        /**
-         * The bucket name containing the object.
-         *
-         * @return Returns a reference to this object so that method calls can be chained together.
-         */
-        BuilderT bucket(String bucket);
-
-        /**
-         * The Key of the object to transfer.
-         *
-         * @return Returns a reference to this object so that method calls can be chained together.
-         */
-        BuilderT key(String key);
-
         TypeToBuildT build();
     }
 }