Deprecate internal checksum APIs and move checksum algorithms from http-auth-aws module to checksums module

Author: zoewangg

.changes/next-release/deprecation-AWSSDKforJavav2-eb641b5.json

@@ -0,0 +1,6 @@
+{
+    "type": "deprecation",
+    "category": "AWS SDK for Java v2",
+    "contributor": "",
+    "description": "Deprecate internal checksum algorithm classes."
+}

build-tools/src/main/resources/software/amazon/awssdk/spotbugs-suppressions.xml

@@ -303,8 +303,8 @@
     <!-- Retrieves and updates crc value in update() -->
      <Match>
          <Or>
-             <Class name="software.amazon.awssdk.http.auth.aws.internal.signer.checksums.SdkCrc32CChecksum"/>
-             <Class name="software.amazon.awssdk.http.auth.aws.internal.signer.checksums.SdkCrc32Checksum"/>
+             <Class name="software.amazon.awssdk.checksums.internal.SdkCrc32CChecksum"/>
+             <Class name="software.amazon.awssdk.checksums.internal.SdkCrc32Checksum"/>
              <Class name="software.amazon.awssdk.core.internal.checksums.factory.SdkCrc32C"/>
              <Class name="software.amazon.awssdk.core.internal.checksums.factory.SdkCrc32"/>
          </Or>

core/checksums/pom.xml

@@ -45,6 +45,19 @@
             <version>${awsjavasdk.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>utils</artifactId>
+            <version>${awsjavasdk.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>software.amazon.awssdk.crt</groupId>
+            <artifactId>aws-crt</artifactId>
+            <version>${awscrt.version}</version>
+            <optional>true</optional>
+        </dependency>
+
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/SdkChecksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/SdkChecksum.java

@@ -13,18 +13,48 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums;
 
 import java.nio.ByteBuffer;
 import java.util.zip.Checksum;
-import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.annotations.SdkProtectedApi;
+import software.amazon.awssdk.checksums.internal.Crc32CChecksum;
+import software.amazon.awssdk.checksums.internal.Crc32Checksum;
+import software.amazon.awssdk.checksums.internal.Crc64NvmeChecksum;
+import software.amazon.awssdk.checksums.internal.Md5Checksum;
+import software.amazon.awssdk.checksums.internal.Sha1Checksum;
+import software.amazon.awssdk.checksums.internal.Sha256Checksum;
+import software.amazon.awssdk.checksums.spi.ChecksumAlgorithm;
 
 /**
  * Extension of {@link Checksum} to support checksums and checksum validations used by the SDK that are not provided by the JDK.
  */
-@SdkInternalApi
+@SdkProtectedApi
 public interface SdkChecksum extends Checksum {
 
+    /**
+     * Returns an {@link SdkChecksum} based on the {@link ChecksumAlgorithm} provided.
+     * UnsupportedOperationException will be thrown for unsupported algorithm.
+     */
+    static SdkChecksum forAlgorithm(ChecksumAlgorithm algorithm) {
+        switch (algorithm.algorithmId()) {
+            case "CRC32C":
+                return new Crc32CChecksum();
+            case "CRC32":
+                return new Crc32Checksum();
+            case "SHA1":
+                return new Sha1Checksum();
+            case "SHA256":
+                return new Sha256Checksum();
+            case "MD5":
+                return new Md5Checksum();
+            case "CRC64NVME":
+                return new Crc64NvmeChecksum();
+            default:
+                throw new UnsupportedOperationException("Unsupported checksum algorithm: " + algorithm);
+        }
+    }
+
     /**
      * Returns the computed checksum in a byte array rather than the long provided by {@link #getValue()}.
      *
@@ -49,7 +79,6 @@ default void update(byte[] b) {
         update(b, 0, b.length);
     }
 
-
     /**
      * Updates the current checksum with the bytes from the specified buffer.
      * <p>

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/BaseCrcChecksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/BaseCrcChecksum.java

@@ -13,10 +13,11 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
 import java.util.zip.Checksum;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 
 /**
  * Base class for CRC related checksums

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/Crc32CChecksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/Crc32CChecksum.java

@@ -13,13 +13,14 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
-import static software.amazon.awssdk.http.auth.aws.internal.signer.util.ChecksumUtil.longToByte;
+import static software.amazon.awssdk.utils.NumericUtils.longToByte;
 
 import java.util.Arrays;
 import java.util.zip.Checksum;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 import software.amazon.awssdk.crt.checksums.CRC32C;
 import software.amazon.awssdk.utils.ClassLoaderHelper;
 

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/Crc32Checksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/Crc32Checksum.java

@@ -13,13 +13,14 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
-import static software.amazon.awssdk.http.auth.aws.internal.signer.util.ChecksumUtil.longToByte;
+import static software.amazon.awssdk.utils.NumericUtils.longToByte;
 
 import java.util.Arrays;
 import java.util.zip.Checksum;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 import software.amazon.awssdk.crt.checksums.CRC32;
 import software.amazon.awssdk.utils.ClassLoaderHelper;
 

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/Crc64NvmeChecksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/Crc64NvmeChecksum.java

@@ -13,25 +13,33 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
-import static software.amazon.awssdk.http.auth.aws.internal.signer.util.ChecksumUtil.longToByte;
-import static software.amazon.awssdk.http.auth.aws.internal.signer.util.OptionalDependencyLoaderUtil.getCrc64Nvme;
+import static software.amazon.awssdk.utils.DependencyValidate.requireClass;
+import static software.amazon.awssdk.utils.NumericUtils.longToByte;
 
 import java.util.zip.Checksum;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 import software.amazon.awssdk.crt.checksums.CRC64NVME;
 
 /**
  * Implementation of {@link SdkChecksum} to calculate an CRC64NVME checksum.
  */
 @SdkInternalApi
 public final class Crc64NvmeChecksum extends BaseCrcChecksum {
+    private static final String CRT_CRC64NVME_PATH = "software.amazon.awssdk.crt.checksums.CRC64NVME";
+    private static final String CRT_MODULE = "software.amazon.awssdk.crt:aws-crt";
 
     public Crc64NvmeChecksum() {
         super(getCrc64Nvme());
     }
 
+    private static CRC64NVME getCrc64Nvme() {
+        requireClass(CRT_CRC64NVME_PATH, CRT_MODULE, "CRC64NVME");
+        return new CRC64NVME();
+    }
+
     @Override
     public Checksum cloneChecksum(Checksum checksum) {
         if (checksum instanceof CRC64NVME) {

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/util/DigestAlgorithm.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/DigestAlgorithm.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.util;
+package software.amazon.awssdk.checksums.internal;
 
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/Md5Checksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/Md5Checksum.java

@@ -13,11 +13,11 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
 import java.security.MessageDigest;
 import software.amazon.awssdk.annotations.SdkInternalApi;
-import software.amazon.awssdk.http.auth.aws.internal.signer.util.DigestAlgorithm;
+import software.amazon.awssdk.checksums.SdkChecksum;
 
 /**
  * Implementation of {@link SdkChecksum} to calculate an MD5 checksum.

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/SdkCrc32CChecksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/SdkCrc32CChecksum.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
 import java.util.zip.Checksum;
 import software.amazon.awssdk.annotations.SdkInternalApi;

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/SdkCrc32Checksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/SdkCrc32Checksum.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
 import java.util.zip.Checksum;
 import software.amazon.awssdk.annotations.SdkInternalApi;

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/Sha1Checksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/Sha1Checksum.java

@@ -13,11 +13,11 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
 import java.security.MessageDigest;
 import software.amazon.awssdk.annotations.SdkInternalApi;
-import software.amazon.awssdk.http.auth.aws.internal.signer.util.DigestAlgorithm;
+import software.amazon.awssdk.checksums.SdkChecksum;
 
 /**
  * Implementation of {@link SdkChecksum} to calculate an Sha-1 checksum.

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/Sha256Checksum.java renamed to core/checksums/src/main/java/software/amazon/awssdk/checksums/internal/Sha256Checksum.java

@@ -13,11 +13,11 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.http.auth.aws.internal.signer.checksums;
+package software.amazon.awssdk.checksums.internal;
 
 import java.security.MessageDigest;
 import software.amazon.awssdk.annotations.SdkInternalApi;
-import software.amazon.awssdk.http.auth.aws.internal.signer.util.DigestAlgorithm;
+import software.amazon.awssdk.checksums.SdkChecksum;
 
 /**
  * Implementation of {@link SdkChecksum} to calculate an Sha-256 Checksum.

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/crt/internal/signer/AwsChunkedV4aPayloadSigner.java

@@ -29,12 +29,12 @@
 import java.util.Collections;
 import java.util.List;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 import software.amazon.awssdk.checksums.spi.ChecksumAlgorithm;
 import software.amazon.awssdk.http.ContentStreamProvider;
 import software.amazon.awssdk.http.Header;
 import software.amazon.awssdk.http.SdkHttpRequest;
 import software.amazon.awssdk.http.auth.aws.internal.signer.CredentialScope;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.SdkChecksum;
 import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChecksumTrailerProvider;
 import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChunkedEncodedInputStream;
 import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.TrailerProvider;

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/AwsChunkedV4PayloadSigner.java

@@ -33,11 +33,11 @@
 import java.util.List;
 import org.reactivestreams.Publisher;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 import software.amazon.awssdk.checksums.spi.ChecksumAlgorithm;
 import software.amazon.awssdk.http.ContentStreamProvider;
 import software.amazon.awssdk.http.Header;
 import software.amazon.awssdk.http.SdkHttpRequest;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.SdkChecksum;
 import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChecksumTrailerProvider;
 import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChunkedEncodedInputStream;
 import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.SigV4ChunkExtensionProvider;

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/FlexibleChecksummer.java

@@ -29,10 +29,10 @@
 import java.util.stream.Collectors;
 import org.reactivestreams.Publisher;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 import software.amazon.awssdk.checksums.spi.ChecksumAlgorithm;
 import software.amazon.awssdk.http.ContentStreamProvider;
 import software.amazon.awssdk.http.SdkHttpRequest;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.SdkChecksum;
 import software.amazon.awssdk.http.auth.aws.internal.signer.io.ChecksumInputStream;
 import software.amazon.awssdk.http.auth.aws.internal.signer.io.ChecksumSubscriber;
 import software.amazon.awssdk.utils.Validate;

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/checksums/ConstantChecksum.java

@@ -17,6 +17,7 @@
 
 import java.nio.charset.StandardCharsets;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 
 /**
  * Implementation of {@link SdkChecksum} to provide a constant checksum.

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/chunkedencoding/ChecksumTrailerProvider.java

@@ -18,7 +18,7 @@
 import java.util.Collections;
 import java.util.List;
 import software.amazon.awssdk.annotations.SdkInternalApi;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.SdkChecksum;
+import software.amazon.awssdk.checksums.SdkChecksum;
 import software.amazon.awssdk.utils.BinaryUtils;
 import software.amazon.awssdk.utils.Pair;
 

core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/util/ChecksumUtil.java

@@ -15,45 +15,20 @@
 
 package software.amazon.awssdk.http.auth.aws.internal.signer.util;
 
-import static software.amazon.awssdk.checksums.DefaultChecksumAlgorithm.CRC32;
-import static software.amazon.awssdk.checksums.DefaultChecksumAlgorithm.CRC32C;
-import static software.amazon.awssdk.checksums.DefaultChecksumAlgorithm.CRC64NVME;
-import static software.amazon.awssdk.checksums.DefaultChecksumAlgorithm.MD5;
-import static software.amazon.awssdk.checksums.DefaultChecksumAlgorithm.SHA1;
-import static software.amazon.awssdk.checksums.DefaultChecksumAlgorithm.SHA256;
-
 import java.io.InputStream;
 import java.nio.ByteBuffer;
 import java.util.Locale;
-import java.util.Map;
-import java.util.function.Supplier;
 import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.checksums.SdkChecksum;
 import software.amazon.awssdk.checksums.spi.ChecksumAlgorithm;
 import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.ConstantChecksum;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.Crc32CChecksum;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.Crc32Checksum;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.Crc64NvmeChecksum;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.Md5Checksum;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.SdkChecksum;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.Sha1Checksum;
-import software.amazon.awssdk.http.auth.aws.internal.signer.checksums.Sha256Checksum;
 import software.amazon.awssdk.utils.FunctionalUtils;
-import software.amazon.awssdk.utils.ImmutableMap;
 
 @SdkInternalApi
 public final class ChecksumUtil {
 
     private static final String CONSTANT_CHECKSUM = "CONSTANT";
 
-    private static final Map<String, Supplier<SdkChecksum>> CHECKSUM_MAP =
-        ImmutableMap.<String, Supplier<SdkChecksum>>builder()
-                    .put(SHA256.algorithmId(), Sha256Checksum::new)
-                    .put(SHA1.algorithmId(), Sha1Checksum::new)
-                    .put(CRC32.algorithmId(), Crc32Checksum::new)
-                    .put(CRC32C.algorithmId(), Crc32CChecksum::new)
-                    .put(MD5.algorithmId(), Md5Checksum::new)
-                    .put(CRC64NVME.algorithmId(), Crc64NvmeChecksum::new).build();
-
     private ChecksumUtil() {
     }
 
@@ -73,15 +48,15 @@ public static String checksumHeaderName(ChecksumAlgorithm checksumAlgorithm) {
      */
     public static SdkChecksum fromChecksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) {
         String algorithmId = checksumAlgorithm.algorithmId();
-        Supplier<SdkChecksum> checksumSupplier = CHECKSUM_MAP.get(algorithmId);
-        if (checksumSupplier != null) {
-            return checksumSupplier.get();
-        }
-
         if (CONSTANT_CHECKSUM.equals(algorithmId)) {
             return new ConstantChecksum(((ConstantChecksumAlgorithm) checksumAlgorithm).value);
         }
 
+        SdkChecksum checksum = SdkChecksum.forAlgorithm(checksumAlgorithm);
+        if (checksum != null) {
+            return checksum;
+        }
+
         throw new UnsupportedOperationException("Checksum not supported for " + algorithmId);
     }