Minor fixes

* Added missing Builder method override for identity
* Fixed javadocs
* Fixed toString

Author: gosar

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

@@ -25,6 +25,11 @@
 import software.amazon.awssdk.identity.spi.Identity;
 import software.amazon.awssdk.utils.builder.SdkBuilder;
 
+/**
+ * Input parameters to sign a request with async payload, using {@link HttpSigner}.
+ *
+ * @param <IdentityT> The type of the identity.
+ */
 @SdkPublicApi
 @Immutable
 @ThreadSafe
@@ -36,6 +41,9 @@ static <IdentityT extends Identity> Builder<IdentityT> builder(IdentityT identit
         return new DefaultAsyncHttpSignRequest.BuilderImpl<>(identity);
     }
 
+    /**
+     * A builder for a {@link AsyncHttpSignRequest}.
+     */
     interface Builder<IdentityT extends Identity> extends HttpSignRequest.Builder<Publisher<ByteBuffer>, IdentityT>,
                                                           SdkBuilder<Builder<IdentityT>, AsyncHttpSignRequest<IdentityT>> {
         @Override

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

@@ -25,35 +25,28 @@
 import software.amazon.awssdk.utils.builder.SdkBuilder;
 
 /**
- * Represents a request that has been signed by {@link HttpSigner}.
- ** //TODO:
+ * Represents a request with async payload that has been signed by {@link HttpSigner}.
  */
 @SdkPublicApi
 @Immutable
 @ThreadSafe
 public interface AsyncSignedHttpRequest extends SignedHttpRequest<Publisher<ByteBuffer>> {
 
     /**
-     * Get a new builder for creating a {@link SyncSignedHttpRequest}.
+     * Get a new builder for creating a {@link AsyncSignedHttpRequest}.
      */
     static Builder builder() {
         return new DefaultAsyncSignedHttpRequest.BuilderImpl();
     }
 
     /**
-     * A builder for a {@link SyncSignedHttpRequest}.
+     * A builder for a {@link AsyncSignedHttpRequest}.
      */
     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

@@ -72,7 +72,7 @@ interface Builder<PayloadT, IdentityT extends Identity> {
         Builder<PayloadT, IdentityT> payload(PayloadT payload);
 
         /**
-         * Set the body payload of the request. A payload is optional. By default, the payload will be empty.
+         * Set the identity of the request.
          */
         Builder<PayloadT, IdentityT> identity(IdentityT identity);
 

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

@@ -24,6 +24,11 @@
 import software.amazon.awssdk.identity.spi.Identity;
 import software.amazon.awssdk.utils.builder.SdkBuilder;
 
+/**
+ * Input parameters to sign a request with sync payload, using {@link HttpSigner}.
+ *
+ * @param <IdentityT> The type of the identity.
+ */
 @SdkPublicApi
 @Immutable
 @ThreadSafe
@@ -35,6 +40,9 @@ static <IdentityT extends Identity> Builder<IdentityT> builder(IdentityT identit
         return new DefaultSyncHttpSignRequest.BuilderImpl<>(identity);
     }
 
+    /**
+     * A builder for a {@link SyncHttpSignRequest}.
+     */
     interface Builder<IdentityT extends Identity> extends HttpSignRequest.Builder<ContentStreamProvider, IdentityT>,
                                                           SdkBuilder<Builder<IdentityT>, SyncHttpSignRequest<IdentityT>> {
         @Override
@@ -43,6 +51,9 @@ 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

@@ -24,8 +24,7 @@
 import software.amazon.awssdk.utils.builder.SdkBuilder;
 
 /**
- * Represents a request that has been signed by {@link HttpSigner}.
- * //TODO:
+ * Represents a request with sync payload that has been signed by {@link HttpSigner}.
  */
 @SdkPublicApi
 @Immutable
@@ -44,15 +43,9 @@ static Builder builder() {
      */
     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

@@ -34,6 +34,7 @@ private DefaultAsyncHttpSignRequest(BuilderImpl<IdentityT> builder) {
     public String toString() {
         return ToString.builder("AsyncHttpSignRequest")
                        .add("request", request)
+                       .add("identity", identity)
                        .add("properties", properties)
                        .build();
     }
@@ -43,9 +44,11 @@ public static final class BuilderImpl<IdentityT extends Identity>
         extends DefaultHttpSignRequest.BuilderImpl<BuilderImpl<IdentityT>, Publisher<ByteBuffer>, IdentityT>
         implements AsyncHttpSignRequest.Builder<IdentityT> {
 
+        // Used to enable consumer builder pattern in HttpSigner.signAsync()
         public BuilderImpl() {
         }
 
+        // Used by AsyncHttpSignRequest#builder() where identity is passed as parameter, to avoid having to pass Class<IdentityT>.
         public BuilderImpl(IdentityT identity) {
             super(identity);
         }

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

@@ -31,7 +31,7 @@ private DefaultAsyncSignedHttpRequest(BuilderImpl builder) {
 
     @Override
     public String toString() {
-        return ToString.builder("SyncSignedHttpRequest")
+        return ToString.builder("AsyncSignedHttpRequest")
                        .add("request", request)
                        .build();
     }

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

@@ -33,6 +33,7 @@ private DefaultSyncHttpSignRequest(BuilderImpl<IdentityT> builder) {
     public String toString() {
         return ToString.builder("SyncHttpSignRequest")
                        .add("request", request)
+                       .add("identity", identity)
                        .add("properties", properties)
                        .build();
     }
@@ -42,9 +43,11 @@ public static final class BuilderImpl<IdentityT extends Identity>
         extends DefaultHttpSignRequest.BuilderImpl<BuilderImpl<IdentityT>, ContentStreamProvider, IdentityT>
         implements SyncHttpSignRequest.Builder<IdentityT> {
 
+        // Used to enable consumer builder pattern in HttpSigner.sign()
         public BuilderImpl() {
         }
 
+        // Used by SyncHttpSignRequest#builder() where identity is passed as parameter, to avoid having to pass Class<IdentityT>.
         public BuilderImpl(IdentityT identity) {
             super(identity);
         }

core/http-auth-spi/src/test/java/software/amazon/awssdk/http/auth/spi/HttpSignerTest.java

@@ -46,7 +46,7 @@ public void sign_usingRequest_works() {
         SyncSignedHttpRequest signedRequest =
             signer.sign(SyncHttpSignRequest.builder(IDENTITY)
                                            .request(mock(SdkHttpRequest.class))
-                                           //.identity(x) // Note, this is doable
+                                           .identity(IDENTITY) // Note, this is doable
                                            .putProperty(KEY, VALUE)
                                            .build());
         assertNotNull(signedRequest);
@@ -69,16 +69,14 @@ public void signAsync_usingRequest_works() {
             signer.signAsync(AsyncHttpSignRequest.builder(IDENTITY)
                                                  .request(mock(SdkHttpRequest.class))
                                                  .payload(payload)
-                                                 //.identity(x) // Note, this is doable
+                                                 .identity(IDENTITY) // Note, this is doable
                                                  .putProperty(KEY, VALUE)
                                                  .build());
         assertNotNull(signedRequest);
     }
 
     /**
-     * NoOp Signer that asserts that the HttpSignRequest created via builder or Consumer builder pattern are set up correctly,
-     * e.g., have the correct payloadType, and makes sure that payloadType works with SignedHttpRequest without runtime
-     * exceptions.
+     * NoOp Signer that asserts that the input created via builder or Consumer builder pattern are set up correctly.
      */
     private class TestSigner implements HttpSigner<TokenIdentity> {
         @Override
@@ -87,9 +85,9 @@ public SyncSignedHttpRequest sign(SyncHttpSignRequest<TokenIdentity> request) {
             assertEquals(IDENTITY, request.identity());
 
             return SyncSignedHttpRequest.builder()
-                                    .request(request.request())
-                                    .payload(request.payload().orElse(null))
-                                    .build();
+                                        .request(request.request())
+                                        .payload(request.payload().orElse(null))
+                                        .build();
         }
 
         @Override
@@ -98,9 +96,9 @@ public AsyncSignedHttpRequest signAsync(AsyncHttpSignRequest<TokenIdentity> requ
             assertEquals(IDENTITY, request.identity());
 
             return AsyncSignedHttpRequest.builder()
-                                    .request(request.request())
-                                    .payload(request.payload().orElse(null))
-                                    .build();
+                                         .request(request.request())
+                                         .payload(request.payload().orElse(null))
+                                         .build();
         }
     }
 }