Add support for presigned DeleteObject

.changes/next-release/feature-AmazonS3-95e65fa.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon S3",
+    "contributor": "",
+    "description": "Add support for presigned `DeleteObject` in `S3Presigner`."
+}

services/s3/src/it/java/software/amazon/awssdk/services/s3/S3PresignerIntegrationTest.java

@@ -50,6 +50,7 @@
 import software.amazon.awssdk.services.s3.presigner.model.PresignedAbortMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedCompleteMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedCreateMultipartUploadRequest;
+import software.amazon.awssdk.services.s3.presigner.model.PresignedDeleteObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedGetObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedPutObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedUploadPartRequest;
@@ -200,6 +201,38 @@ public void getObject_PresignedHttpRequestCanBeInvokedDirectlyBySdk() throws IOE
         }
     }
 
+    @Test
+    public void deleteObject_PresignedHttpRequestCanBeInvokedDirectlyBySdk() throws IOException {
+        String objectKey = generateRandomObjectKey();
+        S3TestUtils.addCleanupTask(S3PresignerIntegrationTest.class,
+                                   () -> client.deleteObject(r -> r.bucket(testBucket).key(objectKey)));
+        client.putObject(r -> r.bucket(testBucket).key(objectKey), RequestBody.fromString("DeleteObjectPresignRequestTest"));
+
+        PresignedDeleteObjectRequest presigned =
+            presigner.presignDeleteObject(r -> r.signatureDuration(Duration.ofMinutes(5))
+                                             .deleteObjectRequest(delo -> delo.bucket(testBucket)
+                                                                         .key(testGetObjectKey)
+                                                                         .requestPayer(RequestPayer.REQUESTER)));
+
+        assertThat(presigned.isBrowserExecutable()).isFalse();
+
+        SdkHttpClient httpClient = ApacheHttpClient.builder().build(); // or UrlConnectionHttpClient.builder().build()
+
+        ContentStreamProvider requestPayload = presigned.signedPayload()
+                                                        .map(SdkBytes::asContentStreamProvider)
+                                                        .orElse(null);
+
+        HttpExecuteRequest request = HttpExecuteRequest.builder()
+                                                       .request(presigned.httpRequest())
+                                                       .contentStreamProvider(requestPayload)
+                                                       .build();
+
+        HttpExecuteResponse response = httpClient.prepareRequest(request).call();
+
+        assertThat(response.responseBody()).isEmpty();
+        assertThat(response.httpResponse().statusCode()).isEqualTo(204);
+    }
+
     @Test
     public void putObject_PresignedHttpRequestCanBeInvokedDirectlyBySdk() throws IOException {
         String objectKey = generateRandomObjectKey();

services/s3/src/main/java/software/amazon/awssdk/services/s3/internal/signing/DefaultS3Presigner.java

@@ -74,17 +74,20 @@
 import software.amazon.awssdk.services.s3.model.AbortMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
+import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
 import software.amazon.awssdk.services.s3.model.GetObjectRequest;
 import software.amazon.awssdk.services.s3.model.PutObjectRequest;
 import software.amazon.awssdk.services.s3.model.UploadPartRequest;
 import software.amazon.awssdk.services.s3.presigner.S3Presigner;
 import software.amazon.awssdk.services.s3.presigner.model.AbortMultipartUploadPresignRequest;
 import software.amazon.awssdk.services.s3.presigner.model.CompleteMultipartUploadPresignRequest;
 import software.amazon.awssdk.services.s3.presigner.model.CreateMultipartUploadPresignRequest;
+import software.amazon.awssdk.services.s3.presigner.model.DeleteObjectPresignRequest;
 import software.amazon.awssdk.services.s3.presigner.model.GetObjectPresignRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedAbortMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedCompleteMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedCreateMultipartUploadRequest;
+import software.amazon.awssdk.services.s3.presigner.model.PresignedDeleteObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedGetObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedPutObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedUploadPartRequest;
@@ -93,6 +96,7 @@
 import software.amazon.awssdk.services.s3.transform.AbortMultipartUploadRequestMarshaller;
 import software.amazon.awssdk.services.s3.transform.CompleteMultipartUploadRequestMarshaller;
 import software.amazon.awssdk.services.s3.transform.CreateMultipartUploadRequestMarshaller;
+import software.amazon.awssdk.services.s3.transform.DeleteObjectRequestMarshaller;
 import software.amazon.awssdk.services.s3.transform.GetObjectRequestMarshaller;
 import software.amazon.awssdk.services.s3.transform.PutObjectRequestMarshaller;
 import software.amazon.awssdk.services.s3.transform.UploadPartRequestMarshaller;
@@ -118,6 +122,7 @@ public final class DefaultS3Presigner extends DefaultSdkPresigner implements S3P
     private final PutObjectRequestMarshaller putObjectRequestMarshaller;
     private final CreateMultipartUploadRequestMarshaller createMultipartUploadRequestMarshaller;
     private final UploadPartRequestMarshaller uploadPartRequestMarshaller;
+    private final DeleteObjectRequestMarshaller deleteObjectRequestMarshaller;
     private final CompleteMultipartUploadRequestMarshaller completeMultipartUploadRequestMarshaller;
     private final AbortMultipartUploadRequestMarshaller abortMultipartUploadRequestMarshaller;
     private final SdkClientConfiguration clientConfiguration;
@@ -172,6 +177,9 @@ private DefaultS3Presigner(Builder b) {
         // Copied from DefaultS3Client#uploadPart
         this.uploadPartRequestMarshaller = new UploadPartRequestMarshaller(protocolFactory);
 
+        // Copied from DefaultS3Client#deleteObject
+        this.deleteObjectRequestMarshaller = new DeleteObjectRequestMarshaller(protocolFactory);
+
         // Copied from DefaultS3Client#completeMultipartUpload
         this.completeMultipartUploadRequestMarshaller = new CompleteMultipartUploadRequestMarshaller(protocolFactory);
 
@@ -247,6 +255,17 @@ public PresignedPutObjectRequest presignPutObject(PutObjectPresignRequest reques
             .build();
     }
 
+    @Override
+    public PresignedDeleteObjectRequest presignDeleteObject(DeleteObjectPresignRequest request) {
+        return presign(PresignedDeleteObjectRequest.builder(),
+                       request,
+                       request.deleteObjectRequest(),
+                       DeleteObjectRequest.class,
+                       deleteObjectRequestMarshaller::marshall,
+                       "DeleteObject")
+            .build();
+    }
+
     @Override
     public PresignedCreateMultipartUploadRequest presignCreateMultipartUpload(CreateMultipartUploadPresignRequest request) {
         return presign(PresignedCreateMultipartUploadRequest.builder(),

services/s3/src/main/java/software/amazon/awssdk/services/s3/presigner/S3Presigner.java

@@ -35,16 +35,19 @@
 import software.amazon.awssdk.services.s3.model.AbortMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
+import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
 import software.amazon.awssdk.services.s3.model.GetObjectRequest;
 import software.amazon.awssdk.services.s3.model.PutObjectRequest;
 import software.amazon.awssdk.services.s3.model.UploadPartRequest;
 import software.amazon.awssdk.services.s3.presigner.model.AbortMultipartUploadPresignRequest;
 import software.amazon.awssdk.services.s3.presigner.model.CompleteMultipartUploadPresignRequest;
 import software.amazon.awssdk.services.s3.presigner.model.CreateMultipartUploadPresignRequest;
+import software.amazon.awssdk.services.s3.presigner.model.DeleteObjectPresignRequest;
 import software.amazon.awssdk.services.s3.presigner.model.GetObjectPresignRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedAbortMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedCompleteMultipartUploadRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedCreateMultipartUploadRequest;
+import software.amazon.awssdk.services.s3.presigner.model.PresignedDeleteObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedGetObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedPutObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedUploadPartRequest;
@@ -339,6 +342,50 @@ default PresignedPutObjectRequest presignPutObject(Consumer<PutObjectPresignRequ
         return presignPutObject(builder.build());
     }
 
+    /**
+     * Presign a {@link DeleteObjectRequest} so that it can be executed at a later time without requiring additional
+     * signing or authentication.
+     * <p>
+     * <b>Example Usage</b>
+     *
+     * <pre>
+     * {@code
+     *     S3Presigner presigner = ...;
+     *
+     *     // Create a DeleteObjectRequest to be pre-signed
+     *     DeleteObjectRequest deleteObjectRequest = ...;
+     *
+     *     // Create a PutObjectPresignRequest to specify the signature duration
+     *     DeleteObjectPresignRequest deleteObjectPresignRequest =
+     *         DeleteObjectPresignRequest.builder()
+     *                                   .signatureDuration(Duration.ofMinutes(10))
+     *                                   .deleteObjectRequest(deleteObjectRequest)
+     *                                   .build();
+     *
+     *     // Generate the presigned request
+     *     PresignedDeleteObjectRequest presignedDeleteObjectRequest =
+     *         presigner.presignDeleteObject(deleteObjectPresignRequest);
+     * }
+     * </pre>
+     */
+    PresignedDeleteObjectRequest presignDeleteObject(DeleteObjectPresignRequest request);
+
+    /**
+     * Presign a {@link DeleteObjectRequest} so that it can be executed at a later time without requiring additional
+     * signing or authentication.
+     * <p>
+     * This is a shorter method of invoking {@link #presignDeleteObject(DeleteObjectPresignRequest)} without needing
+     * to call {@code DeleteObjectPresignRequest.builder()} or {@code .build()}.
+     *
+     * @see #presignDeleteObject(PresignedDeleteObjectRequest)
+     */
+    default PresignedDeleteObjectRequest presignDeleteObject(Consumer<DeleteObjectPresignRequest.Builder> request) {
+        DeleteObjectPresignRequest.Builder builder = DeleteObjectPresignRequest.builder();
+        request.accept(builder);
+        return presignDeleteObject(builder.build());
+    }
+
+
     /**
      * Presign a {@link CreateMultipartUploadRequest} so that it can be executed at a later time without requiring additional
      * signing or authentication.

services/s3/src/main/java/software/amazon/awssdk/services/s3/presigner/model/DeleteObjectPresignRequest.java

@@ -0,0 +1,138 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.s3.presigner.model;
+
+import java.time.Duration;
+import java.util.function.Consumer;
+import software.amazon.awssdk.annotations.Immutable;
+import software.amazon.awssdk.annotations.NotThreadSafe;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
+import software.amazon.awssdk.awscore.presigner.PresignRequest;
+import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
+import software.amazon.awssdk.services.s3.presigner.S3Presigner;
+import software.amazon.awssdk.utils.Validate;
+import software.amazon.awssdk.utils.builder.CopyableBuilder;
+import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
+
+/**
+ * A request to pre-sign a {@link DeleteObjectRequest} so that it can be executed at a later time without requiring additional
+ * signing or authentication.
+ *
+ * @see S3Presigner#presignDeleteObject(DeleteObjectPresignRequest
+ * @see #builder()
+ */
+@SdkPublicApi
+@Immutable
+@ThreadSafe
+public final class DeleteObjectPresignRequest extends PresignRequest
+    implements ToCopyableBuilder<DeleteObjectPresignRequest.Builder, DeleteObjectPresignRequest> {
+    private final DeleteObjectRequest deleteObjectRequest;
+
+    protected DeleteObjectPresignRequest(DefaultBuilder builder) {
+        super(builder);
+        this.deleteObjectRequest = Validate.notNull(builder.deleteObjectRequest, "deleteObjectRequest");
+    }
+
+    /**
+     * Retrieve the {@link DeleteObjectRequest} that should be presigned.
+     */
+    public DeleteObjectRequest deleteObjectRequest()  {
+        return deleteObjectRequest;
+    }
+
+    @Override
+    public Builder toBuilder() {
+        return new DefaultBuilder(this);
+    }
+
+    /**
+     * Create a builder that can be used to create a {@link DeleteObjectPresignRequest}.
+     *
+     * @see S3Presigner#presignDeleteObject(DeleteObjectPresignRequest)
+     */
+    public static Builder builder() {
+        return new DefaultBuilder();
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        if (!super.equals(o)) {
+            return false;
+        }
+
+        DeleteObjectPresignRequest that = (DeleteObjectPresignRequest) o;
+
+        return deleteObjectRequest.equals(that.deleteObjectRequest);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = super.hashCode();
+        result = 31 * result + deleteObjectRequest.hashCode();
+        return result;
+    }
+
+    @SdkPublicApi
+    @NotThreadSafe
+    public interface Builder extends PresignRequest.Builder,
+                                     CopyableBuilder<DeleteObjectPresignRequest.Builder, DeleteObjectPresignRequest> {
+        Builder deleteObjectRequest(DeleteObjectRequest deleteObjectRequest);
+
+        default Builder deleteObjectRequest(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest) {
+            DeleteObjectRequest.Builder builder = DeleteObjectRequest.builder();
+            deleteObjectRequest.accept(builder);
+            return deleteObjectRequest(builder.build());
+        }
+
+        @Override
+        Builder signatureDuration(Duration signatureDuration);
+
+        @Override
+        DeleteObjectPresignRequest build();
+    }
+
+    @SdkInternalApi
+    private static final class DefaultBuilder extends PresignRequest.DefaultBuilder<DefaultBuilder> implements Builder {
+        private DeleteObjectRequest deleteObjectRequest;
+
+        private DefaultBuilder() {
+        }
+
+        private DefaultBuilder(DeleteObjectPresignRequest deleteObjectPresignRequest) {
+            super(deleteObjectPresignRequest);
+            this.deleteObjectRequest = deleteObjectPresignRequest.deleteObjectRequest;
+        }
+
+        @Override
+        public Builder deleteObjectRequest(DeleteObjectRequest deleteObjectRequest) {
+            this.deleteObjectRequest = deleteObjectRequest;
+            return this;
+        }
+
+        @Override
+        public DeleteObjectPresignRequest build() {
+            return new DeleteObjectPresignRequest(this);
+        }
+    }
+}