HDDS-12989. Throw CodecException for the Codec byte[] methods.

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/security/x509/certificate/utils/CertificateCodec.java

@@ -137,10 +137,8 @@ public static String getPEMEncodedString(X509Certificate certificate)
     try {
       return writePEMEncoded(certificate, new StringWriter()).toString();
     } catch (IOException e) {
-      LOG.error("Error in encoding certificate." + certificate
-          .getSubjectDN().toString(), e);
-      throw new SCMSecurityException("PEM Encoding failed for certificate." +
-          certificate.getSubjectDN().toString(), e, PEM_ENCODE_FAILED);
+      throw new SCMSecurityException("Failed to getPEMEncodedString for certificate with subject "
+          + certificate.getSubjectDN(), e, PEM_ENCODE_FAILED);
     }
   }
 
@@ -155,9 +153,13 @@ public static String getPEMEncodedString(X509Certificate certificate)
    */
   public static X509Certificate getX509Certificate(String pemEncoded)
       throws CertificateException {
+    return getX509Certificate(pemEncoded.getBytes(DEFAULT_CHARSET));
+  }
+
+  public static X509Certificate getX509Certificate(byte[] pemEncoded)
+      throws CertificateException {
     // ByteArrayInputStream.close(), which is a noop, can be safely ignored.
-    final ByteArrayInputStream input = new ByteArrayInputStream(
-        pemEncoded.getBytes(DEFAULT_CHARSET));
+    final ByteArrayInputStream input = new ByteArrayInputStream(pemEncoded);
     return readX509Certificate(input);
   }
 

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/utils/db/Codec.java

@@ -18,7 +18,7 @@
 package org.apache.hadoop.hdds.utils.db;
 
 import jakarta.annotation.Nonnull;
-import java.io.IOException;
+import java.util.Objects;
 
 /**
  * Codec interface to serialize/deserialize objects to/from bytes.
@@ -90,14 +90,46 @@ default T fromCodecBuffer(@Nonnull CodecBuffer buffer) throws CodecException {
    * Convert object to raw persisted format.
    * @param object The original java object. Should not be null.
    */
-  byte[] toPersistedFormat(T object) throws IOException;
+  default byte[] toPersistedFormat(T object) throws CodecException {
+    Objects.requireNonNull(object, "object == null");
+    try {
+      return toPersistedFormatImpl(object);
+    } catch (Exception e) {
+      throw new CodecException("Failed to serialize " + object
+          + " for " + object.getClass(), e);
+    }
+  }
+
+  /**
+   * The same as {@link #toPersistedFormat} except that this method throws {@link Exception}.
+   * A subclass must implement either {@link #toPersistedFormat} or this method.
+   */
+  default byte[] toPersistedFormatImpl(T object) throws Exception {
+    throw new UnsupportedOperationException();
+  }
 
   /**
    * Convert object from raw persisted format.
    *
    * @param rawData Byte array from the key/value store. Should not be null.
    */
-  T fromPersistedFormat(byte[] rawData) throws IOException;
+  default T fromPersistedFormat(byte[] rawData) throws CodecException {
+    Objects.requireNonNull(rawData, "rawData == null");
+    try {
+      return fromPersistedFormatImpl(rawData);
+    } catch (Exception e) {
+      throw new CodecException("Failed to deserialize rawData (length=" + rawData.length
+          + ") for " + getTypeClass(), e);
+    }
+  }
+
+  /**
+   * The same as {@link #fromPersistedFormat} except that this method throws {@link Exception}.
+   * A subclass must implement either {@link #fromPersistedFormat} or this method.
+   */
+  default T fromPersistedFormatImpl(byte[] rawData) throws Exception {
+    throw new UnsupportedOperationException();
+  }
 
   /**
    * Copy the given object.

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/utils/db/DelegatedCodec.java

@@ -18,7 +18,6 @@
 package org.apache.hadoop.hdds.utils.db;
 
 import jakarta.annotation.Nonnull;
-import java.io.IOException;
 import org.apache.ratis.util.JavaUtils;
 import org.apache.ratis.util.function.CheckedFunction;
 
@@ -85,12 +84,12 @@ public final T fromCodecBuffer(@Nonnull CodecBuffer buffer) throws CodecExceptio
   }
 
   @Override
-  public final byte[] toPersistedFormat(T message) throws IOException {
+  public final byte[] toPersistedFormat(T message) throws CodecException {
     return delegate.toPersistedFormat(backward.apply(message));
   }
 
   @Override
-  public final T fromPersistedFormat(byte[] bytes) throws IOException {
+  public final T fromPersistedFormat(byte[] bytes) throws CodecException {
     return forward.apply(delegate.fromPersistedFormat(bytes));
   }
 

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/utils/db/Proto2Codec.java

@@ -105,7 +105,7 @@ public byte[] toPersistedFormat(M message) {
   }
 
   @Override
-  public M fromPersistedFormat(byte[] bytes)
+  public M fromPersistedFormatImpl(byte[] bytes)
       throws InvalidProtocolBufferException {
     return parser.parseFrom(bytes);
   }

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/utils/db/Proto3Codec.java

@@ -95,7 +95,7 @@ public byte[] toPersistedFormat(M message) {
   }
 
   @Override
-  public M fromPersistedFormat(byte[] bytes)
+  public M fromPersistedFormatImpl(byte[] bytes)
       throws InvalidProtocolBufferException {
     return parser.parseFrom(bytes);
   }

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/utils/db/StringCodecBase.java

@@ -18,7 +18,6 @@
 package org.apache.hadoop.hdds.utils.db;
 
 import jakarta.annotation.Nonnull;
-import java.io.IOException;
 import java.nio.ByteBuffer;
 import java.nio.CharBuffer;
 import java.nio.charset.Charset;
@@ -183,8 +182,8 @@ public String fromCodecBuffer(@Nonnull CodecBuffer buffer) {
   }
 
   @Override
-  public byte[] toPersistedFormat(String object) throws IOException {
-    return string2Bytes(object, IOException::new);
+  public byte[] toPersistedFormat(String object) throws CodecException {
+    return string2Bytes(object, CodecException::new);
   }
 
   @Override

hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/utils/db/Proto2CodecTestBase.java

@@ -19,6 +19,7 @@
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
 import com.google.protobuf.InvalidProtocolBufferException;
@@ -31,11 +32,13 @@ public abstract class Proto2CodecTestBase<T> {
   public abstract Codec<T> getCodec();
 
   @Test
-  public void testInvalidProtocolBuffer() throws Exception {
-    InvalidProtocolBufferException exception =
-        assertThrows(InvalidProtocolBufferException.class,
+  public void testInvalidProtocolBuffer() {
+    final CodecException exception =
+        assertThrows(CodecException.class,
             () -> getCodec().fromPersistedFormat("random".getBytes(UTF_8)));
-    assertThat(exception.getMessage())
+    final InvalidProtocolBufferException cause = assertInstanceOf(
+        InvalidProtocolBufferException.class, exception.getCause());
+    assertThat(cause.getMessage())
         .contains("the input ended unexpectedly");
   }
 

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/metadata/SchemaOneChunkInfoListCodec.java

@@ -17,9 +17,9 @@
 
 package org.apache.hadoop.ozone.container.metadata;
 
-import java.io.IOException;
 import org.apache.hadoop.hdds.protocol.datanode.proto.ContainerProtos;
 import org.apache.hadoop.hdds.utils.db.Codec;
+import org.apache.hadoop.hdds.utils.db.CodecException;
 import org.apache.hadoop.ozone.container.common.helpers.ChunkInfoList;
 import org.apache.ratis.thirdparty.com.google.protobuf.InvalidProtocolBufferException;
 
@@ -67,12 +67,12 @@ public byte[] toPersistedFormat(ChunkInfoList chunkList) {
   }
 
   @Override
-  public ChunkInfoList fromPersistedFormat(byte[] rawData) throws IOException {
+  public ChunkInfoList fromPersistedFormat(byte[] rawData) throws CodecException {
     try {
       return ChunkInfoList.getFromProtoBuf(
               ContainerProtos.ChunkInfoList.parseFrom(rawData));
     } catch (InvalidProtocolBufferException ex) {
-      throw new IOException("Invalid chunk information. " +
+      throw new CodecException("Invalid chunk information. " +
               "This data may have been written using datanode " +
               "schema version one, which did not save chunk information.", ex);
     }

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/metadata/SchemaOneKeyCodec.java

@@ -17,8 +17,8 @@
 
 package org.apache.hadoop.ozone.container.metadata;
 
-import java.io.IOException;
 import org.apache.hadoop.hdds.utils.db.Codec;
+import org.apache.hadoop.hdds.utils.db.CodecException;
 import org.apache.hadoop.hdds.utils.db.LongCodec;
 import org.apache.hadoop.hdds.utils.db.StringCodec;
 import org.slf4j.Logger;
@@ -52,7 +52,7 @@ public Class<String> getTypeClass() {
   }
 
   @Override
-  public byte[] toPersistedFormat(String stringObject) throws IOException {
+  public byte[] toPersistedFormat(String stringObject) throws CodecException {
     try {
       // If the caller's string has no prefix, it should be stored as a long
       // to be encoded as a long to be consistent with the schema one

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/metadata/BigIntegerCodec.java

@@ -17,7 +17,6 @@
 
 package org.apache.hadoop.hdds.scm.metadata;
 
-import java.io.IOException;
 import java.math.BigInteger;
 import org.apache.hadoop.hdds.utils.db.Codec;
 
@@ -42,12 +41,12 @@ public Class<BigInteger> getTypeClass() {
   }
 
   @Override
-  public byte[] toPersistedFormat(BigInteger object) throws IOException {
+  public byte[] toPersistedFormat(BigInteger object) {
     return object.toByteArray();
   }
 
   @Override
-  public BigInteger fromPersistedFormat(byte[] rawData) throws IOException {
+  public BigInteger fromPersistedFormat(byte[] rawData) {
     return new BigInteger(rawData);
   }
 

hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/metadata/OldPipelineIDCodecForTesting.java

@@ -17,9 +17,7 @@
 
 package org.apache.hadoop.hdds.scm.metadata;
 
-import java.io.IOException;
 import java.nio.ByteBuffer;
-import java.util.Arrays;
 import java.util.UUID;
 import org.apache.hadoop.hdds.scm.pipeline.PipelineID;
 import org.apache.hadoop.hdds.utils.db.Codec;
@@ -34,7 +32,7 @@ public Class<PipelineID> getTypeClass() {
   }
 
   @Override
-  public byte[] toPersistedFormat(PipelineID object) throws IOException {
+  public byte[] toPersistedFormat(PipelineID object) {
     byte[] bytes = new byte[16];
     System.arraycopy(
         asByteArray(object.getId().getMostSignificantBits()), 0, bytes, 0, 8);
@@ -50,23 +48,18 @@ private byte[] asByteArray(long bits) {
   }
 
   @Override
-  public PipelineID fromPersistedFormat(byte[] rawData) throws IOException {
+  public PipelineID fromPersistedFormatImpl(byte[] rawData) {
     long mostSiginificantBits = toLong(rawData, 0);
     long leastSignificantBits = toLong(rawData, 8);
 
     UUID id = new UUID(mostSiginificantBits, leastSignificantBits);
     return PipelineID.valueOf(id);
   }
 
-  private long toLong(byte[] arr, int startIdx) throws IOException {
+  private long toLong(byte[] arr, int startIdx) {
     if (arr.length < startIdx + 8) {
-      throw new IOException("Key conversion error.",
-          new ArrayIndexOutOfBoundsException(
-              "Key does not have the least expected amount of bytes,"
-                  + "and does not contain a UUID. Key: "
-                  + Arrays.toString(arr)
-          )
-      );
+      throw new ArrayIndexOutOfBoundsException(
+          "Not enough bytes: length (=" + arr.length + ") - startIdx (=" + startIdx + ") < 8");
     }
     ByteBuffer buffer = ByteBuffer.allocate(Long.BYTES);
     buffer.put(arr, startIdx, 8);

hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/metadata/OldX509CertificateCodecForTesting.java

@@ -17,7 +17,6 @@
 
 package org.apache.hadoop.hdds.scm.metadata;
 
-import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.security.cert.CertificateException;
 import java.security.cert.X509Certificate;
@@ -48,24 +47,14 @@ public Class<X509Certificate> getTypeClass() {
   }
 
   @Override
-  public byte[] toPersistedFormat(X509Certificate object) throws IOException {
-    try {
-      return CertificateCodec.getPEMEncodedString(object)
-          .getBytes(StandardCharsets.UTF_8);
-    } catch (SCMSecurityException exp) {
-      throw new IOException(exp);
-    }
+  public byte[] toPersistedFormatImpl(X509Certificate object) throws SCMSecurityException {
+    return CertificateCodec.getPEMEncodedString(object)
+        .getBytes(StandardCharsets.UTF_8);
   }
 
   @Override
-  public X509Certificate fromPersistedFormat(byte[] rawData)
-      throws IOException {
-    try {
-      String s = new String(rawData, StandardCharsets.UTF_8);
-      return CertificateCodec.getX509Certificate(s);
-    } catch (CertificateException exp) {
-      throw new IOException(exp);
-    }
+  public X509Certificate fromPersistedFormatImpl(byte[] rawData) throws CertificateException {
+    return CertificateCodec.getX509Certificate(rawData);
   }
 
   @Override

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/SnapshotDiffJob.java

@@ -315,14 +315,12 @@ public Class<SnapshotDiffJob> getTypeClass() {
     }
 
     @Override
-    public byte[] toPersistedFormat(SnapshotDiffJob object)
-        throws IOException {
+    public byte[] toPersistedFormatImpl(SnapshotDiffJob object) throws IOException {
       return MAPPER.writeValueAsBytes(object);
     }
 
     @Override
-    public SnapshotDiffJob fromPersistedFormat(byte[] rawData)
-        throws IOException {
+    public SnapshotDiffJob fromPersistedFormatImpl(byte[] rawData) throws IOException {
       return MAPPER.readValue(rawData, SnapshotDiffJob.class);
     }
 

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/security/OzoneTokenIdentifier.java

@@ -117,7 +117,7 @@ public OzoneTokenIdentifier fromUniqueSerializedKey(byte[] rawData)
     return this;
   }
 
-  public OMTokenProto toProtoBuf() throws IOException {
+  public OMTokenProto toProtoBuf() {
     OMTokenProto.Builder builder = OMTokenProto.newBuilder()
         .setMaxDate(getMaxDate())
         .setType(getTokenType())