Split sync/async interfaces for SignedHttpRequest

And removed `payloadType()` accessor.

Also, HttpSignRequest builders take Identity as parameter instead of Class<IdentityT>.

Author: gosar

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/AsyncHttpSignRequest.java

@@ -32,14 +32,8 @@ public interface AsyncHttpSignRequest<IdentityT extends Identity> extends HttpSi
     /**
      * Get a new builder for creating a {@link AsyncHttpSignRequest}.
      */
-    static <IdentityT extends Identity> Builder<IdentityT> builder(Class<IdentityT> ignoredIdentityType) {
-        return new DefaultAsyncHttpSignRequest.BuilderImpl<>();
-    }
-
-    @Override
-    default Class<Publisher<ByteBuffer>> payloadType() {
-        // TODO: Code Review Note: Note this cast
-        return (Class) Publisher.class;
+    static <IdentityT extends Identity> Builder<IdentityT> builder(IdentityT identity) {
+        return new DefaultAsyncHttpSignRequest.BuilderImpl<>(identity);
     }
 
     interface Builder<IdentityT extends Identity> extends HttpSignRequest.Builder<Publisher<ByteBuffer>, IdentityT>,

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/AsyncSignedHttpRequest.java

@@ -0,0 +1,60 @@
+/*
+ * 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.http.auth.spi;
+
+import java.nio.ByteBuffer;
+import org.reactivestreams.Publisher;
+import software.amazon.awssdk.annotations.Immutable;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
+import software.amazon.awssdk.http.SdkHttpRequest;
+import software.amazon.awssdk.http.auth.spi.internal.DefaultAsyncSignedHttpRequest;
+import software.amazon.awssdk.utils.builder.SdkBuilder;
+
+/**
+ * Represents a request that has been signed by {@link HttpSigner}.
+ ** //TODO:
+ */
+@SdkPublicApi
+@Immutable
+@ThreadSafe
+public interface AsyncSignedHttpRequest extends SignedHttpRequest<Publisher<ByteBuffer>> {
+
+    /**
+     * Get a new builder for creating a {@link SyncSignedHttpRequest}.
+     */
+    static Builder builder() {
+        return new DefaultAsyncSignedHttpRequest.BuilderImpl();
+    }
+
+    /**
+     * A builder for a {@link SyncSignedHttpRequest}.
+     */
+    interface Builder extends SignedHttpRequest.Builder<Publisher<ByteBuffer>>, SdkBuilder<Builder, AsyncSignedHttpRequest> {
+
+        /**
+         * Set the HTTP request object, without the request body payload.
+         */
+        @Override
+        Builder request(SdkHttpRequest request);
+
+        /**
+         * Set the body payload of the request. A payload is optional. By default, the payload will be empty.
+         */
+        @Override
+        Builder payload(Publisher<ByteBuffer> payload);
+    }
+}

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/HttpSignRequest.java

@@ -36,11 +36,6 @@
 @ThreadSafe
 public interface HttpSignRequest<PayloadT, IdentityT extends Identity> {
 
-    /**
-     * Returns the type of the payload.
-     */
-    Class<PayloadT> payloadType();
-
     /**
      * Returns the HTTP request object, without the request body payload.
      */
@@ -51,6 +46,9 @@ public interface HttpSignRequest<PayloadT, IdentityT extends Identity> {
      */
     Optional<PayloadT> payload();
 
+    /**
+     * Returns the identity.
+     */
     IdentityT identity();
 
     /**

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/HttpSigner.java

@@ -15,11 +15,8 @@
 
 package software.amazon.awssdk.http.auth.spi;
 
-import java.nio.ByteBuffer;
 import java.util.function.Consumer;
-import org.reactivestreams.Publisher;
 import software.amazon.awssdk.annotations.SdkPublicApi;
-import software.amazon.awssdk.http.ContentStreamProvider;
 import software.amazon.awssdk.http.auth.spi.internal.DefaultAsyncHttpSignRequest;
 import software.amazon.awssdk.http.auth.spi.internal.DefaultSyncHttpSignRequest;
 import software.amazon.awssdk.identity.spi.Identity;
@@ -39,18 +36,19 @@ public interface HttpSigner<IdentityT extends Identity> {
      * @param request The inputs to sign a request.
      * @return A signed version of the request.
      */
-    SignedHttpRequest<ContentStreamProvider> sign(SyncHttpSignRequest<IdentityT> request);
+    SyncSignedHttpRequest sign(SyncHttpSignRequest<IdentityT> request);
 
     /**
      * Method that takes in inputs to sign a request with sync payload and returns a signed version of the request.
      * <p>
      * Similar to {@link #sign(SyncHttpSignRequest)}, but takes a lambda to configure a new {@link SyncHttpSignRequest.Builder}.
-     * This removes the need to call {@link SyncHttpSignRequest#builder(Class)}} and {@link SyncHttpSignRequest.Builder#build()}.
+     * This removes the need to call {@link SyncHttpSignRequest#builder(IdentityT)}} and
+     * {@link SyncHttpSignRequest.Builder#build()}.
      *
      * @param consumer A {@link Consumer} to which an empty {@link SyncHttpSignRequest.Builder} will be given.
      * @return A signed version of the request.
      */
-    default SignedHttpRequest<ContentStreamProvider> sign(Consumer<SyncHttpSignRequest.Builder<IdentityT>> consumer) {
+    default SyncSignedHttpRequest sign(Consumer<SyncHttpSignRequest.Builder<IdentityT>> consumer) {
         return sign(new DefaultSyncHttpSignRequest.BuilderImpl<IdentityT>().applyMutation(consumer).build());
     }
 
@@ -60,19 +58,19 @@ default SignedHttpRequest<ContentStreamProvider> sign(Consumer<SyncHttpSignReque
      * @param request The inputs to sign a request.
      * @return A signed version of the request.
      */
-    SignedHttpRequest<Publisher<ByteBuffer>> signAsync(AsyncHttpSignRequest<IdentityT> request);
+    AsyncSignedHttpRequest signAsync(AsyncHttpSignRequest<IdentityT> request);
 
     /**
      * Method that takes in inputs to sign a request with async payload and returns a signed version of the request.
      * <p>
      * Similar to {@link #signAsync(AsyncHttpSignRequest)}, but takes a lambda to configure a new
-     * {@link AsyncHttpSignRequest.Builder}. This removes the need to call {@link AsyncHttpSignRequest#builder(Class)}} and
+     * {@link AsyncHttpSignRequest.Builder}. This removes the need to call {@link AsyncHttpSignRequest#builder(IdentityT)}} and
      * {@link AsyncHttpSignRequest.Builder#build()}.
      *
      * @param consumer A {@link Consumer} to which an empty {@link HttpSignRequest.Builder} will be given.
      * @return A signed version of the request.
      */
-    default SignedHttpRequest<Publisher<ByteBuffer>> signAsync(Consumer<AsyncHttpSignRequest.Builder<IdentityT>> consumer) {
+    default AsyncSignedHttpRequest signAsync(Consumer<AsyncHttpSignRequest.Builder<IdentityT>> consumer) {
         return signAsync(new DefaultAsyncHttpSignRequest.BuilderImpl<IdentityT>().applyMutation(consumer).build());
     }
 }

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/SignedHttpRequest.java

@@ -20,8 +20,6 @@
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.http.SdkHttpRequest;
-import software.amazon.awssdk.http.auth.spi.internal.DefaultSignedHttpRequest;
-import software.amazon.awssdk.utils.builder.SdkBuilder;
 
 /**
  * Represents a request that has been signed by {@link HttpSigner}.
@@ -33,18 +31,6 @@
 @ThreadSafe
 public interface SignedHttpRequest<PayloadT> {
 
-    /**
-     * Get a new builder for creating a {@link SignedHttpRequest}.
-     */
-    static <T> Builder<T> builder(Class<T> payloadType) {
-        return new DefaultSignedHttpRequest.BuilderImpl<>(payloadType);
-    }
-
-    /**
-     * Returns the type of the payload.
-     */
-    Class<PayloadT> payloadType();
-
     /**
      * Returns the HTTP request object, without the request body payload.
      */
@@ -58,7 +44,7 @@ static <T> Builder<T> builder(Class<T> payloadType) {
     /**
      * A builder for a {@link SignedHttpRequest}.
      */
-    interface Builder<PayloadT> extends SdkBuilder<Builder<PayloadT>, SignedHttpRequest<PayloadT>> {
+    interface Builder<PayloadT> {
 
         /**
          * Set the HTTP request object, without the request body payload.

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/SyncHttpSignRequest.java

@@ -31,13 +31,8 @@ public interface SyncHttpSignRequest<IdentityT extends Identity> extends HttpSig
     /**
      * Get a new builder for creating a {@link SyncHttpSignRequest}.
      */
-    static <IdentityT extends Identity> Builder<IdentityT> builder(Class<IdentityT> ignoredIdentityType) {
-        return new DefaultSyncHttpSignRequest.BuilderImpl<>();
-    }
-
-    @Override
-    default Class<ContentStreamProvider> payloadType() {
-        return ContentStreamProvider.class;
+    static <IdentityT extends Identity> Builder<IdentityT> builder(IdentityT identity) {
+        return new DefaultSyncHttpSignRequest.BuilderImpl<>(identity);
     }
 
     interface Builder<IdentityT extends Identity> extends HttpSignRequest.Builder<ContentStreamProvider, IdentityT>,
@@ -48,9 +43,6 @@ interface Builder<IdentityT extends Identity> extends HttpSignRequest.Builder<Co
         @Override
         Builder<IdentityT> payload(ContentStreamProvider payload);
 
-        @Override
-        Builder<IdentityT> identity(IdentityT identity);
-
         @Override
         <T> Builder<IdentityT> putProperty(SignerProperty<T> key, T value);
     }

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/SyncSignedHttpRequest.java

@@ -0,0 +1,59 @@
+/*
+ * 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.http.auth.spi;
+
+import software.amazon.awssdk.annotations.Immutable;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
+import software.amazon.awssdk.http.ContentStreamProvider;
+import software.amazon.awssdk.http.SdkHttpRequest;
+import software.amazon.awssdk.http.auth.spi.internal.DefaultSyncSignedHttpRequest;
+import software.amazon.awssdk.utils.builder.SdkBuilder;
+
+/**
+ * Represents a request that has been signed by {@link HttpSigner}.
+ * //TODO:
+ */
+@SdkPublicApi
+@Immutable
+@ThreadSafe
+public interface SyncSignedHttpRequest extends SignedHttpRequest<ContentStreamProvider> {
+
+    /**
+     * Get a new builder for creating a {@link SyncSignedHttpRequest}.
+     */
+    static Builder builder() {
+        return new DefaultSyncSignedHttpRequest.BuilderImpl();
+    }
+
+    /**
+     * A builder for a {@link SyncSignedHttpRequest}.
+     */
+    interface Builder extends SignedHttpRequest.Builder<ContentStreamProvider>, SdkBuilder<Builder, SyncSignedHttpRequest> {
+
+        /**
+         * Set the HTTP request object, without the request body payload.
+         */
+        @Override
+        Builder request(SdkHttpRequest request);
+
+        /**
+         * Set the body payload of the request. A payload is optional. By default, the payload will be empty.
+         */
+        @Override
+        Builder payload(ContentStreamProvider payload);
+    }
+}

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/internal/DefaultAsyncHttpSignRequest.java

@@ -43,6 +43,13 @@ public static final class BuilderImpl<IdentityT extends Identity>
         extends DefaultHttpSignRequest.BuilderImpl<BuilderImpl<IdentityT>, Publisher<ByteBuffer>, IdentityT>
         implements AsyncHttpSignRequest.Builder<IdentityT> {
 
+        public BuilderImpl() {
+        }
+
+        public BuilderImpl(IdentityT identity) {
+            super(identity);
+        }
+
         @Override
         public AsyncHttpSignRequest<IdentityT> build() {
             return new DefaultAsyncHttpSignRequest<>(this);

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/internal/DefaultAsyncSignedHttpRequest.java

@@ -0,0 +1,49 @@
+/*
+ * 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.http.auth.spi.internal;
+
+import java.nio.ByteBuffer;
+import org.reactivestreams.Publisher;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.http.auth.spi.AsyncSignedHttpRequest;
+import software.amazon.awssdk.utils.ToString;
+
+@SdkInternalApi
+public final class DefaultAsyncSignedHttpRequest
+    extends DefaultSignedHttpRequest<Publisher<ByteBuffer>> implements AsyncSignedHttpRequest {
+
+    private DefaultAsyncSignedHttpRequest(BuilderImpl builder) {
+        super(builder);
+    }
+
+    @Override
+    public String toString() {
+        return ToString.builder("SyncSignedHttpRequest")
+                       .add("request", request)
+                       .build();
+    }
+
+    @SdkInternalApi
+    public static final class BuilderImpl
+        extends DefaultSignedHttpRequest.BuilderImpl<BuilderImpl, Publisher<ByteBuffer>>
+        implements AsyncSignedHttpRequest.Builder {
+
+        @Override
+        public AsyncSignedHttpRequest build() {
+            return new DefaultAsyncSignedHttpRequest(this);
+        }
+    }
+}

core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/internal/DefaultHttpSignRequest.java

@@ -62,12 +62,19 @@ public <T> T property(SignerProperty<T> property) {
 
     @SdkInternalApi
     protected static class BuilderImpl<B extends BuilderImpl<B, PayloadT, IdentityT>, PayloadT, IdentityT extends Identity>
-        implements HttpSignRequest.Builder<PayloadT, IdentityT> {
+        implements Builder<PayloadT, IdentityT> {
         private SdkHttpRequest request;
         private PayloadT payload;
         private IdentityT identity;
         private final Map<SignerProperty<?>, Object> properties = new HashMap<>();
 
+        protected BuilderImpl() {
+        }
+
+        protected BuilderImpl(IdentityT identity) {
+            this.identity = identity;
+        }
+
         @Override
         public B request(SdkHttpRequest request) {
             this.request = request;