HDDS-14655. Add a generic type to ScmCodec (#9789)

Russole · web-flow · commit 85f7d619b5bb · 2026-02-19T11:52:31.000+01:00
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmBigIntegerCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmBigIntegerCodec.java
@@ -24,16 +24,16 @@
 /**
  * Codec for type BigInteger.
  */
-public class ScmBigIntegerCodec implements ScmCodec {
+public class ScmBigIntegerCodec implements ScmCodec<BigInteger> {
 
   @Override
-  public ByteString serialize(Object object) {
+  public ByteString serialize(BigInteger object) {
     // BigInteger returns a new byte[].
-    return UnsafeByteOperations.unsafeWrap(((BigInteger) object).toByteArray());
+    return UnsafeByteOperations.unsafeWrap(object.toByteArray());
   }
 
   @Override
-  public Object deserialize(Class< ? > type, ByteString value) {
+  public BigInteger deserialize(Class< ? > type, ByteString value) {
     return new BigInteger(value.toByteArray());
   }
 }
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmBooleanCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmBooleanCodec.java
@@ -22,13 +22,13 @@
 /**
  * {@link ScmCodec} for {@code Boolean} objects.
  */
-public class ScmBooleanCodec implements ScmCodec {
+public class ScmBooleanCodec implements ScmCodec<Boolean> {
   static final ByteString TRUE = ByteString.copyFromUtf8(Boolean.TRUE.toString());
   static final ByteString FALSE = ByteString.copyFromUtf8(Boolean.FALSE.toString());
 
   @Override
-  public ByteString serialize(Object object) {
-    return ((Boolean) object) ? TRUE : FALSE;
+  public ByteString serialize(Boolean object) {
+    return object ? TRUE : FALSE;
   }
 
   @Override
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmByteStringCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmByteStringCodec.java
@@ -18,22 +18,19 @@
 package org.apache.hadoop.hdds.scm.ha.io;
 
 import org.apache.ratis.thirdparty.com.google.protobuf.ByteString;
-import org.apache.ratis.thirdparty.com.google.protobuf.InvalidProtocolBufferException;
 
 /**
  * A dummy codec that serializes a ByteString object to ByteString.
  */
-public class ScmByteStringCodec implements ScmCodec {
+public class ScmByteStringCodec implements ScmCodec<ByteString> {
 
   @Override
-  public ByteString serialize(Object object)
-      throws InvalidProtocolBufferException {
-    return (ByteString) object;
+  public ByteString serialize(ByteString object) {
+    return object;
   }
 
   @Override
-  public Object deserialize(Class<?> type, ByteString value)
-      throws InvalidProtocolBufferException {
+  public ByteString deserialize(Class<?> type, ByteString value) {
     return value;
   }
 }
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmCodec.java
@@ -21,13 +21,14 @@
 import org.apache.ratis.thirdparty.com.google.protobuf.InvalidProtocolBufferException;
 
 /**
- * Codec interface to marshall/unmarshall data to/from {@link ByteString}.
+ * To serialize/deserialize Java objects to/from protobuf ByteString for SCM HA.
+ *
+ * @param <T>
  */
-public interface ScmCodec {
+public interface ScmCodec<T> {
 
-  ByteString serialize(Object object) throws InvalidProtocolBufferException;
+  ByteString serialize(T object) throws InvalidProtocolBufferException;
 
-  Object deserialize(Class<?> type, ByteString value)
-      throws InvalidProtocolBufferException;
+  T deserialize(Class<?> type, ByteString value) throws InvalidProtocolBufferException;
 
 }
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmEnumCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmEnumCodec.java
@@ -28,7 +28,7 @@
 /**
  * {@link ScmCodec} for {@link ProtocolMessageEnum} objects.
  */
-public class ScmEnumCodec implements ScmCodec {
+public class ScmEnumCodec implements ScmCodec<Object>  {
 
   @Override
   public ByteString serialize(Object object)
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmGeneratedMessageCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmGeneratedMessageCodec.java
@@ -26,7 +26,7 @@
 /**
  * {@link ScmCodec} for {@link Message} objects.
  */
-public class ScmGeneratedMessageCodec implements ScmCodec {
+public class ScmGeneratedMessageCodec implements ScmCodec<Object> {
 
   @Override
   public ByteString serialize(Object object) throws InvalidProtocolBufferException {
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmIntegerCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmIntegerCodec.java
@@ -19,23 +19,20 @@
 
 import com.google.common.primitives.Ints;
 import org.apache.ratis.thirdparty.com.google.protobuf.ByteString;
-import org.apache.ratis.thirdparty.com.google.protobuf.InvalidProtocolBufferException;
 import org.apache.ratis.thirdparty.com.google.protobuf.UnsafeByteOperations;
 
 /**
  * Encodes/decodes an integer to a byte string.
  */
-public class ScmIntegerCodec implements ScmCodec {
+public class ScmIntegerCodec implements ScmCodec<Integer> {
   @Override
-  public ByteString serialize(Object object)
-      throws InvalidProtocolBufferException {
+  public ByteString serialize(Integer object) {
     // toByteArray returns a new array
-    return UnsafeByteOperations.unsafeWrap(Ints.toByteArray((Integer) object));
+    return UnsafeByteOperations.unsafeWrap(Ints.toByteArray(object));
   }
 
   @Override
-  public Object deserialize(Class<?> type, ByteString value)
-      throws InvalidProtocolBufferException {
+  public Integer deserialize(Class<?> type, ByteString value) {
     return Ints.fromByteArray(value.toByteArray());
   }
 }
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmListCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmListCodec.java
@@ -28,7 +28,7 @@
 /**
  * {@link ScmCodec} for {@link List} objects.
  */
-public class ScmListCodec implements ScmCodec {
+public class ScmListCodec implements ScmCodec<Object> {
 
   @Override
   public ByteString serialize(Object object)
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmLongCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmLongCodec.java
@@ -19,24 +19,21 @@
 
 import com.google.common.primitives.Longs;
 import org.apache.ratis.thirdparty.com.google.protobuf.ByteString;
-import org.apache.ratis.thirdparty.com.google.protobuf.InvalidProtocolBufferException;
 import org.apache.ratis.thirdparty.com.google.protobuf.UnsafeByteOperations;
 
 /**
  * {@link ScmCodec} for {@code Long} objects.
  */
-public class ScmLongCodec implements ScmCodec {
+public class ScmLongCodec implements ScmCodec<Long> {
 
   @Override
-  public ByteString serialize(Object object)
-      throws InvalidProtocolBufferException {
+  public ByteString serialize(Long object) {
     // toByteArray returns a new array
-    return UnsafeByteOperations.unsafeWrap(Longs.toByteArray((Long) object));
+    return UnsafeByteOperations.unsafeWrap(Longs.toByteArray(object));
   }
 
   @Override
-  public Object deserialize(Class<?> type, ByteString value)
-      throws InvalidProtocolBufferException {
+  public Long deserialize(Class<?> type, ByteString value) {
     return Longs.fromByteArray(value.toByteArray());
   }
 
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmManagedSecretKeyCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmManagedSecretKeyCodec.java
@@ -26,17 +26,17 @@
 /**
  * A codec for {@link ManagedSecretKey} objects.
  */
-public class ScmManagedSecretKeyCodec implements ScmCodec {
+public class ScmManagedSecretKeyCodec implements ScmCodec<ManagedSecretKey> {
   @Override
-  public ByteString serialize(Object object)
+  public ByteString serialize(ManagedSecretKey object)
       throws InvalidProtocolBufferException {
-    ManagedSecretKey secretKey = (ManagedSecretKey) object;
+    ManagedSecretKey secretKey = object;
     return UnsafeByteOperations.unsafeWrap(
         secretKey.toProtobuf().toByteString().asReadOnlyByteBuffer());
   }
 
   @Override
-  public Object deserialize(Class<?> type, ByteString value)
+  public ManagedSecretKey deserialize(Class<?> type, ByteString value)
       throws InvalidProtocolBufferException {
     try {
       SCMSecretKeyProtocolProtos.ManagedSecretKey message =
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmNonShadedByteStringCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmNonShadedByteStringCodec.java
@@ -18,26 +18,21 @@
 package org.apache.hadoop.hdds.scm.ha.io;
 
 import org.apache.ratis.thirdparty.com.google.protobuf.ByteString;
-import org.apache.ratis.thirdparty.com.google.protobuf.InvalidProtocolBufferException;
 import org.apache.ratis.thirdparty.com.google.protobuf.UnsafeByteOperations;
 
 /**
  * {@link ScmCodec} implementation for non-shaded
  * {@link com.google.protobuf.ByteString} objects.
  */
-public class ScmNonShadedByteStringCodec implements ScmCodec {
+public class ScmNonShadedByteStringCodec implements ScmCodec<com.google.protobuf.ByteString> {
 
   @Override
-  public ByteString serialize(Object object)
-      throws InvalidProtocolBufferException {
-    return UnsafeByteOperations.unsafeWrap(
-        ((com.google.protobuf.ByteString) object).asReadOnlyByteBuffer());
+  public ByteString serialize(com.google.protobuf.ByteString object) {
+    return UnsafeByteOperations.unsafeWrap(object.asReadOnlyByteBuffer());
   }
 
   @Override
-  public Object deserialize(Class<?> type, ByteString value)
-      throws InvalidProtocolBufferException {
-    return com.google.protobuf.UnsafeByteOperations.
-        unsafeWrap(value.asReadOnlyByteBuffer());
+  public com.google.protobuf.ByteString deserialize(Class<?> type, ByteString value) {
+    return com.google.protobuf.UnsafeByteOperations.unsafeWrap(value.asReadOnlyByteBuffer());
   }
 }
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmNonShadedGeneratedMessageCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmNonShadedGeneratedMessageCodec.java
@@ -28,7 +28,7 @@
  * {@link ScmCodec} implementation for non-shaded
  * {@link com.google.protobuf.Message} objects.
  */
-public class ScmNonShadedGeneratedMessageCodec implements ScmCodec {
+public class ScmNonShadedGeneratedMessageCodec implements ScmCodec<Object> {
 
   @Override
   public ByteString serialize(Object object)
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmStringCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmStringCodec.java
@@ -25,15 +25,15 @@
 /**
  * {@link ScmCodec} for {@code String} objects.
  */
-public class ScmStringCodec implements ScmCodec {
+public class ScmStringCodec implements ScmCodec<String> {
   @Override
-  public ByteString serialize(Object object) {
+  public ByteString serialize(String object) {
     // getBytes returns a new array
-    return UnsafeByteOperations.unsafeWrap(((String) object).getBytes(UTF_8));
+    return UnsafeByteOperations.unsafeWrap(object.getBytes(UTF_8));
   }
 
   @Override
-  public Object deserialize(Class<?> type, ByteString value) {
+  public String deserialize(Class<?> type, ByteString value) {
     return new String(value.toByteArray(), UTF_8);
   }
 }
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmX509CertificateCodec.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ScmX509CertificateCodec.java
@@ -28,13 +28,13 @@
 /**
  * Codec for type X509Certificate.
  */
-public class ScmX509CertificateCodec implements ScmCodec {
+public class ScmX509CertificateCodec implements ScmCodec<X509Certificate> {
   @Override
-  public ByteString serialize(Object object)
+  public ByteString serialize(X509Certificate object)
       throws InvalidProtocolBufferException {
     try {
       String certString =
-          CertificateCodec.getPEMEncodedString((X509Certificate) object);
+          CertificateCodec.getPEMEncodedString(object);
       // getBytes returns a new array
       return UnsafeByteOperations.unsafeWrap(certString.getBytes(UTF_8));
     } catch (Exception ex) {
@@ -44,7 +44,7 @@ public ByteString serialize(Object object)
   }
 
   @Override
-  public Object deserialize(Class< ? > type, ByteString value)
+  public X509Certificate deserialize(Class< ? > type, ByteString value)
       throws InvalidProtocolBufferException {
     try {
       String pemEncodedCert = new String(value.toByteArray(), UTF_8);
diff --git a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/io/TestScmBigIntegerCodec.java b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/io/TestScmBigIntegerCodec.java
@@ -35,8 +35,7 @@ public void testCodec() {
     BigInteger bigInteger = BigInteger.valueOf(100);
     ByteString byteString = scmBigIntegerCodec.serialize(bigInteger);
 
-    BigInteger actual =
-        (BigInteger) scmBigIntegerCodec.deserialize(BigInteger.class, byteString);
+    BigInteger actual = scmBigIntegerCodec.deserialize(BigInteger.class, byteString);
     assertEquals(bigInteger, actual);
   }
 }
diff --git a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/io/TestScmX509CertificateCodec.java b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/io/TestScmX509CertificateCodec.java
@@ -52,8 +52,7 @@ public void codec() throws Exception {
     ScmX509CertificateCodec scmX509CertificateCodec = new ScmX509CertificateCodec();
     ByteString byteString = scmX509CertificateCodec.serialize(x509Certificate);
 
-    X509Certificate actual = (X509Certificate)
-        scmX509CertificateCodec.deserialize(X509Certificate.class, byteString);
+    X509Certificate actual = scmX509CertificateCodec.deserialize(X509Certificate.class, byteString);
 
     assertEquals(x509Certificate, actual);
 

Original file line number	Diff line number	Diff line change
`@@ -24,16 +24,16 @@`
`24`	`24`	`/**`
`25`	`25`	`* Codec for type BigInteger.`
`26`	`26`	`*/`
`27`		`-public class ScmBigIntegerCodec implements ScmCodec {`
	`27`	`+public class ScmBigIntegerCodec implements ScmCodec<BigInteger> {`
`28`	`28`
`29`	`29`	`@Override`
`30`		`- public ByteString serialize(Object object) {`
	`30`	`+ public ByteString serialize(BigInteger object) {`
`31`	`31`	`// BigInteger returns a new byte[].`
`32`		`- return UnsafeByteOperations.unsafeWrap(((BigInteger) object).toByteArray());`
	`32`	`+ return UnsafeByteOperations.unsafeWrap(object.toByteArray());`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Override`
`36`		`- public Object deserialize(Class< ? > type, ByteString value) {`
	`36`	`+ public BigInteger deserialize(Class< ? > type, ByteString value) {`
`37`	`37`	`return new BigInteger(value.toByteArray());`
`38`	`38`	`}`
`39`	`39`	`}`