Addressing PR Comments

Author: pandhera

.changes/next-release/feature-AxdbFrontend-d6ce1e6.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AxdbFrontend",
+    "contributor": "APandher",
+    "description": "Add IAM Token Generation Utility for AxdbFrontend"
+}

docs/LaunchChangelog.md

@@ -453,10 +453,6 @@ The S3 client in 2.0 is drastically different from the client in 1.11, because i
 
 1. The class`RdsIamAuthTokenGenerator` has been replaced with `RdsUtilities#generateAuthenticationToken`.
 
-## 4.5. Axdbfrontend Changes
-
-1. The class `AxdbfrontendUtilities#generateAuthenticationToken` can now be used to generate an Authentication token to connect to a Xanadu database.
-
 # 5. Profile File Changes
 
 The parsing of the `~/.aws/config` and `~/.aws/credentials` has changed to more closely emulate that used by the AWS CLI.

services/axdbfrontend/pom.xml

@@ -41,6 +41,11 @@
         </plugins>
     </build>
     <dependencies>
+        <dependency>
+            <groupId>nl.jqno.equalsverifier</groupId>
+            <artifactId>equalsverifier</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>software.amazon.awssdk</groupId>
             <artifactId>protocol-core</artifactId>

services/axdbfrontend/src/main/java/software/amazon/awssdk/services/axdbfrontend/AxdbFrontendUtilities.java

@@ -21,33 +21,32 @@
 import software.amazon.awssdk.identity.spi.AwsCredentialsIdentity;
 import software.amazon.awssdk.identity.spi.IdentityProvider;
 import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.axdbfrontend.internal.DefaultAxdbFrontendUtilities;
 import software.amazon.awssdk.services.axdbfrontend.model.GenerateAuthenticationTokenRequest;
 
 /**
  * Utilities for working with AxdbFrontend. An instance of this class can be created by:
  * <p>
  * 1) Using the low-level client {@link AxdbFrontendClient#utilities()} (or {@link AxdbFrontendAsyncClient#utilities()}} method.
- * This is
- * recommended as SDK will use the same configuration from the {@link AxdbFrontendClient} object to create the
- * {@link AxdbFrontendUtilities}
- * object.
+ * This is recommended as SDK will use the same configuration from the {@link AxdbFrontendClient} object to create the
+ * {@link AxdbFrontendUtilities} object.
  *
- * <pre>
+ * @snippet :
+ * {@code
  * AxdbFrontendClient AxdbFrontendClient = AxdbFrontendClient.create();
  * AxdbFrontendUtilities utilities = AxdbFrontendClient.utilities();
- * </pre>
- * </p>
+ * }
  *
  * <p>
  * 2) Directly using the {@link #builder()} method.
  *
- * <pre>
+ * @snippet :
+ * {@code
  * AxdbFrontendUtilities utilities = AxdbFrontendUtilities.builder()
  *  .credentialsProvider(DefaultCredentialsProvider.create())
  *  .region(Region.US_WEST_2)
  *  .build()
- * </pre>
- * </p>
+ * }
  *
  * Note: This class does not make network calls.
  */
@@ -61,7 +60,7 @@ static Builder builder() {
     }
 
     /**
-     * Generates an authentication token for IAM authentication to a Xanadu database.
+     * Generates an authentication token for IAM authentication to an AxdbFrontend database.
      *
      * @param request The request used to generate the authentication token
      * @return String to use as the AxdbFrontend authentication token
@@ -72,7 +71,7 @@ default String generateAuthenticationToken(Consumer<GenerateAuthenticationTokenR
     }
 
     /**
-     * Generates an authentication token for IAM authentication to an Xanadu database.
+     * Generates an authentication token for IAM authentication to an AxdbFrontend database.
      *
      * @param request The request used to generate the authentication token
      * @return String to use as the AxdbFrontend authentication token

services/axdbfrontend/src/main/java/software/amazon/awssdk/services/axdbfrontend/DefaultAxdbFrontendUtilities.java renamed to services/axdbfrontend/src/main/java/software/amazon/awssdk/services/axdbfrontend/internal/DefaultAxdbFrontendUtilities.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.services.axdbfrontend;
+package software.amazon.awssdk.services.axdbfrontend.internal;
 
 import java.time.Clock;
 import java.time.Instant;
@@ -30,28 +30,29 @@
 import software.amazon.awssdk.identity.spi.AwsCredentialsIdentity;
 import software.amazon.awssdk.identity.spi.IdentityProvider;
 import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.axdbfrontend.AxdbFrontendUtilities;
 import software.amazon.awssdk.services.axdbfrontend.model.GenerateAuthenticationTokenRequest;
 import software.amazon.awssdk.utils.CompletableFutureUtils;
 import software.amazon.awssdk.utils.Logger;
 import software.amazon.awssdk.utils.StringUtils;
 
 @Immutable
 @SdkInternalApi
-final class DefaultAxdbFrontendUtilities implements AxdbFrontendUtilities {
+public final class DefaultAxdbFrontendUtilities implements AxdbFrontendUtilities {
     private static final Logger log = Logger.loggerFor(AxdbFrontendUtilities.class);
     private final Aws4Signer signer = Aws4Signer.create();
     private final Region region;
     private final IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider;
     private final Clock clock;
 
-    DefaultAxdbFrontendUtilities(DefaultBuilder builder) {
+    public DefaultAxdbFrontendUtilities(DefaultBuilder builder) {
         this(builder, Clock.systemUTC());
     }
 
     /**
      * For testing purposes only
      */
-    DefaultAxdbFrontendUtilities(DefaultBuilder builder, Clock clock) {
+    public DefaultAxdbFrontendUtilities(DefaultBuilder builder, Clock clock) {
         this.credentialsProvider = builder.credentialsProvider;
         this.region = builder.region;
         this.clock = clock;
@@ -72,7 +73,7 @@ public String generateAuthenticationToken(GenerateAuthenticationTokenRequest req
                                                            .protocol("https")
                                                            .host(request.hostname())
                                                            .encodedPath("/")
-                                                           .putRawQueryParameter("Action", request.action().name())
+                                                           .putRawQueryParameter("Action", request.action().getAction())
                                                            .build();
 
         Instant expirationTime = Instant.now(clock).plus(request.expiresIn());
@@ -105,6 +106,7 @@ private Region resolveRegion(GenerateAuthenticationTokenRequest request) {
                                            "or AxdbFrontendUtilities object");
     }
 
+    // TODO: update this to use AwsCredentialsIdentity when we migrate Signers to accept the new type.
     private AwsCredentials resolveCredentials(GenerateAuthenticationTokenRequest request) {
         if (request.credentialsIdentityProvider() != null) {
             return CredentialUtils.toCredentials(
@@ -120,11 +122,11 @@ private AwsCredentials resolveCredentials(GenerateAuthenticationTokenRequest req
     }
 
     @SdkInternalApi
-    static final class DefaultBuilder implements Builder {
+    public static final class DefaultBuilder implements Builder {
         private Region region;
         private IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider;
 
-        DefaultBuilder() {
+        public DefaultBuilder() {
         }
 
         Builder clientConfiguration(SdkClientConfiguration clientConfiguration) {

services/axdbfrontend/src/main/java/software/amazon/awssdk/services/axdbfrontend/model/Action.java

@@ -16,21 +16,32 @@
 package software.amazon.awssdk.services.axdbfrontend.model;
 
 import java.io.Serializable;
+import software.amazon.awssdk.annotations.SdkPublicApi;
 
 /**
- * Enumerations of possible actions that can be performed on a Xanadu database.
+ * Enumerations of possible actions that can be performed on an AxdbFrontend database.
  */
+@SdkPublicApi
 public enum Action implements Serializable {
-    DbConnect,
-    DbConnectSuperuser;
+    DB_CONNECT("DbConnect"),
+    DB_CONNECT_SUPERUSER("DbConnectSuperuser");
+
+    private final String action;
+
+    Action(String action) {
+        this.action = action;
+    }
+
+    public String getAction() {
+        return action;
+    }
 
     public static Action variant(String value) {
-        if (value.equalsIgnoreCase(Action.DbConnect.name())) {
-            return Action.DbConnect;
-        } else if (value.equalsIgnoreCase(Action.DbConnectSuperuser.name())) {
-            return Action.DbConnectSuperuser;
-        } else {
-            throw new IllegalArgumentException("Invalid action: " + value);
+        for (Action action : Action.values()) {
+            if (value.equalsIgnoreCase(action.name())) {
+                return action;
+            }
         }
+        throw new IllegalArgumentException("Invalid action: " + value);
     }
 }

services/axdbfrontend/src/main/java/software/amazon/awssdk/services/axdbfrontend/model/GenerateAuthenticationTokenRequest.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.services.axdbfrontend.model;
 
 import java.time.Duration;
+import java.util.Objects;
 import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
@@ -25,6 +26,7 @@
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.axdbfrontend.AxdbFrontendUtilities;
 import software.amazon.awssdk.services.axdbfrontend.model.Action;
+import software.amazon.awssdk.utils.ToString;
 import software.amazon.awssdk.utils.Validate;
 import software.amazon.awssdk.utils.builder.CopyableBuilder;
 import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
@@ -37,6 +39,8 @@
 public final class GenerateAuthenticationTokenRequest implements
                                                       ToCopyableBuilder<GenerateAuthenticationTokenRequest.Builder,
                                                           GenerateAuthenticationTokenRequest> {
+    // The time the IAM token is good for based on RDS. https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
+    private static final Duration EXPIRATION_DURATION = Duration.ofSeconds(900L);
 
     private final String hostname;
     private final Region region;
@@ -47,11 +51,49 @@ public final class GenerateAuthenticationTokenRequest implements
     private GenerateAuthenticationTokenRequest(BuilderImpl builder) {
         this.hostname = Validate.notEmpty(builder.hostname, "hostname");
         this.action = Validate.notNull(builder.action, "action");
-        Validate.isTrue(this.action == Action.DbConnect || this.action == Action.DbConnectSuperuser, "invalid action");
+        Validate.isTrue(this.action == Action.DB_CONNECT || this.action == Action.DB_CONNECT_SUPERUSER, "invalid action");
         this.region = builder.region;
         this.credentialsProvider = builder.credentialsProvider;
         this.expiresIn = (builder.expiresIn != null) ? builder.expiresIn :
-                             Duration.ofSeconds(900L);
+                             EXPIRATION_DURATION;
+    }
+
+    @Override
+    public String toString() {
+        return ToString.builder("GenerateAuthenticationTokenRequest")
+                       .add("hostname", hostname)
+                       .add("region", region)
+                       .add("action", action)
+                       .add("expiresIn", expiresIn)
+                       .add("credentialsProvider", credentialsProvider)
+                       .build();
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        GenerateAuthenticationTokenRequest that = (GenerateAuthenticationTokenRequest) o;
+        return Objects.equals(hostname, that.hostname) &&
+               Objects.equals(region, that.region) &&
+               Objects.equals(action, that.action) &&
+               Objects.equals(expiresIn, that.expiresIn) &&
+               Objects.equals(credentialsProvider, that.credentialsProvider);
+    }
+
+    @Override
+    public int hashCode() {
+        int hashCode = 1;
+        hashCode = 31 * hashCode + Objects.hashCode(hostname);
+        hashCode = 31 * hashCode + Objects.hashCode(region);
+        hashCode = 31 * hashCode + Objects.hashCode(action);
+        hashCode = 31 * hashCode + Objects.hashCode(expiresIn);
+        hashCode = 31 * hashCode + Objects.hashCode(credentialsProvider);
+        return hashCode;
     }
 
     /**
@@ -62,7 +104,7 @@ public String hostname() {
     }
 
     /**
-     * @return The token expiry duration in seconds
+     * @return The token expiry duration
      */
     public Duration expiresIn() {
         return expiresIn;
@@ -141,8 +183,7 @@ public interface Builder extends CopyableBuilder<Builder, GenerateAuthentication
         Builder region(Region region);
 
         /**
-         * The region the database is hosted in. If specified, takes precedence over the value specified in
-         * {@link AxdbFrontendUtilities.Builder#region(Region)}
+         * The duration a token is valid for.
          *
          * @return This object for method chaining
          */