Add presignHeadObjec method to S3Presigner

.changes/next-release/feature-AWSS3-45d047b.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS S3",
+    "contributor": "tmccombs",
+    "description": "Add `presignHeadObject` to S3Presigner"
+}

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

@@ -97,6 +97,7 @@
 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.HeadObjectRequest;
 import software.amazon.awssdk.services.s3.model.PutObjectRequest;
 import software.amazon.awssdk.services.s3.model.UploadPartRequest;
 import software.amazon.awssdk.services.s3.presigner.S3Presigner;
@@ -105,11 +106,13 @@
 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.HeadObjectPresignRequest;
 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.PresignedHeadObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedPutObjectRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PresignedUploadPartRequest;
 import software.amazon.awssdk.services.s3.presigner.model.PutObjectPresignRequest;
@@ -141,6 +144,7 @@ public final class DefaultS3Presigner extends DefaultSdkPresigner implements S3P
     private final S3Configuration serviceConfiguration;
     private final List<ExecutionInterceptor> clientInterceptors;
     private final GetObjectRequestMarshaller getObjectRequestMarshaller;
+    private final HeadObjectRequestMarshaller headObjectRequestMarshaller;
     private final PutObjectRequestMarshaller putObjectRequestMarshaller;
     private final CreateMultipartUploadRequestMarshaller createMultipartUploadRequestMarshaller;
     private final UploadPartRequestMarshaller uploadPartRequestMarshaller;
@@ -273,6 +277,17 @@ public PresignedGetObjectRequest presignGetObject(GetObjectPresignRequest reques
             .build();
     }
 
+    @Override
+    public PresignedGetObjectRequest presignHeadObject(HeadObjectPresignRequest request) {
+        return presign(PresignedHeadObjectRequest.builder(),
+                       request,
+                       request.headObjectRequest(),
+                       HeadObjectRequest.class,
+                       headObjectRequestMarshaller::marshall,
+                       "HeadObject")
+            .build();
+    }
+
     @Override
     public PresignedPutObjectRequest presignPutObject(PutObjectPresignRequest request) {
         return presign(PresignedPutObjectRequest.builder(),

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

@@ -0,0 +1,151 @@
+/*
+ * 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.HeadObjectRequest;
+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 HeadObjectRequest} so that it can be executed at a later time without requiring additional
+ * signing or authentication.
+ *
+ * @see S3Presigner#presignHeadObject(HeadObjectPresignRequest)
+ * @see #builder()
+ */
+@SdkPublicApi
+@Immutable
+@ThreadSafe
+public final class HeadObjectPresignRequest
+        extends PresignRequest
+        implements ToCopyableBuilder<HeadObjectPresignRequest.Builder, HeadObjectPresignRequest> {
+    private final HeadObjectRequest headObjectRequest;
+
+    private HeadObjectPresignRequest(DefaultBuilder builder) {
+        super(builder);
+        this.headObjectRequest = Validate.notNull(builder.headObjectRequest, "headObjectRequest");
+    }
+
+    /**
+     * Create a builder that can be used to create a {@link HeadObjectPresignRequest}.
+     *
+     * @see S3Presigner#presignHeadObject(HeadObjectPresignRequest)
+     */
+    public static Builder builder() {
+        return new DefaultBuilder();
+    }
+
+    /**
+     * Retrieve the {@link HeadObjectRequest} that should be presigned.
+     */
+    public HeadObjectRequest headObjectRequest() {
+        return headObjectRequest;
+    }
+
+    @Override
+    public Builder toBuilder() {
+        return new DefaultBuilder(this);
+    }
+
+    @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;
+        }
+
+        HeadObjectPresignRequest that = (HeadObjectPresignRequest) o;
+
+        return headObjectRequest.equals(that.headObjectRequest);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = super.hashCode();
+        result = 31 * result + headObjectRequest.hashCode();
+        return result;
+    }
+
+    /**
+     * A builder for a {@link HeadObjectPresignRequest}, created with {@link #builder()}.
+     */
+    @SdkPublicApi
+    @NotThreadSafe
+    public interface Builder extends PresignRequest.Builder,
+                                     CopyableBuilder<HeadObjectPresignRequest.Builder, HeadObjectPresignRequest> {
+        /**
+         * Configure the {@link HeadObjectRequest} that should be presigned.
+         */
+        Builder headObjectRequest(HeadObjectRequest headObjectRequest);
+
+        /**
+         * Configure the {@link HeadObjectRequest} that should be presigned.
+         * <p/>
+         * This is a convenience method for invoking {@link #headObjectRequest(HeadObjectRequest)} without needing to invoke
+         * {@code HeadObjectRequest.builder()} or {@code build()}.
+         */
+        default Builder headObjectRequest(Consumer<HeadObjectRequest.Builder> headObjectRequest) {
+            HeadObjectRequest.Builder builder = HeadObjectRequest.builder();
+            headObjectRequest.accept(builder);
+            return headObjectRequest(builder.build());
+        }
+
+        @Override
+        Builder signatureDuration(Duration signatureDuration);
+
+        @Override
+        HeadObjectPresignRequest build();
+    }
+
+    @SdkInternalApi
+    private static final class DefaultBuilder extends PresignRequest.DefaultBuilder<DefaultBuilder> implements Builder {
+        private HeadObjectRequest headObjectRequest;
+
+        private DefaultBuilder() {
+        }
+
+        private DefaultBuilder(HeadObjectPresignRequest request) {
+            super(request);
+            this.headObjectRequest = request.headObjectRequest;
+        }
+
+        @Override
+        public Builder headObjectRequest(HeadObjectRequest headObjectRequest) {
+            this.headObjectRequest = headObjectRequest;
+            return this;
+        }
+
+        @Override
+        public HeadObjectPresignRequest build() {
+            return new HeadObjectPresignRequest(this);
+        }
+    }
+}

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

@@ -0,0 +1,107 @@
+/*
+ * 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.Instant;
+import java.util.List;
+import java.util.Map;
+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.PresignedRequest;
+import software.amazon.awssdk.core.SdkBytes;
+import software.amazon.awssdk.http.SdkHttpRequest;
+import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
+import software.amazon.awssdk.services.s3.presigner.S3Presigner;
+import software.amazon.awssdk.utils.builder.CopyableBuilder;
+import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
+
+/**
+ * A pre-signed a {@link HeadObjectRequest} that can be executed at a later time without requiring additional signing or
+ * authentication.
+ *
+ * @see S3Presigner#presignHeadObject(HeadObjectPresignRequest)
+ * @see #builder()
+ */
+@SdkPublicApi
+@Immutable
+@ThreadSafe
+public class PresignedHeadObjectRequest
+        extends PresignedRequest
+        implements ToCopyableBuilder<PresignedHeadObjectRequest.Builder, PresignedHeadObjectRequest> {
+    private PresignedHeadObjectRequest(DefaultBuilder builder) {
+        super(builder);
+    }
+
+    /**
+     * Create a builder that can be used to create a {@link PresignedHeadObjectRequest}.
+     *
+     * @see S3Presigner#presignHeadObject(HeadObjectPresignRequest)
+     */
+    public static Builder builder() {
+        return new DefaultBuilder();
+    }
+
+    @Override
+    public Builder toBuilder() {
+        return new DefaultBuilder(this);
+    }
+
+    /**
+     * A builder for a {@link PresignedHeadObjectRequest}, created with {@link #builder()}.
+     */
+    @SdkPublicApi
+    @NotThreadSafe
+    public interface Builder extends PresignedRequest.Builder,
+                                     CopyableBuilder<PresignedHeadObjectRequest.Builder, PresignedHeadObjectRequest> {
+        @Override
+        Builder expiration(Instant expiration);
+
+        @Override
+        Builder isBrowserExecutable(Boolean isBrowserExecutable);
+
+        @Override
+        Builder signedHeaders(Map<String, List<String>> signedHeaders);
+
+        @Override
+        Builder signedPayload(SdkBytes signedPayload);
+
+        @Override
+        Builder httpRequest(SdkHttpRequest httpRequest);
+
+        @Override
+        PresignedHeadObjectRequest build();
+    }
+
+    @SdkInternalApi
+    private static final class DefaultBuilder
+            extends PresignedRequest.DefaultBuilder<DefaultBuilder>
+            implements Builder {
+        private DefaultBuilder() {
+        }
+
+        private DefaultBuilder(PresignedHeadObjectRequest request) {
+            super(request);
+        }
+
+        @Override
+        public PresignedHeadObjectRequest build() {
+            return new PresignedHeadObjectRequest(this);
+        }
+    }
+}