Enh 36466628 - [36404724->24.09] Enh: Return error message if field with POF related annotation declared as final

(auto-submit 108126 after successfully running remote remote.full)
Job ID: job.9.20240401210206.27926

[git-p4: depot-paths = "//dev/coherence-ce/main/": change = 108130]

Author: chpatel3

prj/coherence-core/src/main/java/com/oracle/coherence/common/schema/ClassFileSchemaSource.java

@@ -689,7 +689,7 @@ public static Predicate<ClassNode> hasAnnotation(final Class clzAnnotation)
     // ---- Constants -------------------------------------------------------
 
     private static final int EXCLUDED_FIELDS =
-            Opcodes.ACC_STATIC | Opcodes.ACC_FINAL | Opcodes.ACC_TRANSIENT;
+            Opcodes.ACC_STATIC | Opcodes.ACC_TRANSIENT;
 
     // ---- Data members ----------------------------------------------------
 

prj/coherence-core/src/main/java/com/tangosol/io/pof/schema/handler/ClassFileHandler.java

@@ -1,8 +1,8 @@
 /*
- * Copyright (c) 2013, 2020, Oracle and/or its affiliates.
+ * Copyright (c) 2013, 2024, Oracle and/or its affiliates.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
- * http://oss.oracle.com/licenses/upl.
+ * https://oss.oracle.com/licenses/upl.
  */
 package com.tangosol.io.pof.schema.handler;
 
@@ -34,13 +34,15 @@
 import com.tangosol.io.pof.schema.annotation.PortableSet;
 import com.tangosol.io.pof.schema.annotation.PortableType;
 
+import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.Type;
 import org.objectweb.asm.tree.AnnotationNode;
 import org.objectweb.asm.tree.ClassNode;
 import org.objectweb.asm.tree.FieldNode;
 
 import static com.oracle.coherence.common.schema.util.AsmUtils.getAnnotationAttribute;
 
+
 /**
  * Reads {@link PofType} metadata from a class file.
  *
@@ -99,6 +101,12 @@ public void importProperty(PofProperty property, FieldNode source, Schema schema
             AnnotationNode an = AsmUtils.getAnnotation(source, PORTABLE_ANNOTATIONS);
             if (an != null)
                 {
+                if ((source.access & Opcodes.ACC_FINAL) == Opcodes.ACC_FINAL)
+                    {
+                    throw new IllegalStateException(String.format("Field '%s' annotated with '@%s' cannot be final",
+                            source.name, an.desc.substring(1, an.desc.length() - 1).replace('/', '.')));
+                    }
+
                 property.setSince((Integer) getAnnotationAttribute(an, "since"));
                 property.setOrder((Integer) getAnnotationAttribute(an, "order"));
 

prj/test/unit/coherence-tests/src/test/java/com/tangosol/io/pof/generator/PortableTypeGeneratorTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, 2023, Oracle and/or its affiliates.
+ * Copyright (c) 2012, 2024, Oracle and/or its affiliates.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
  * https://oss.oracle.com/licenses/upl.
@@ -35,6 +35,7 @@
 import java.util.Map;
 import java.util.Properties;
 
+import com.tangosol.io.pof.generator.data.FinalFieldValue;
 import com.tangosol.io.pof.generator.data.Simple;
 import org.hamcrest.MatcherAssert;
 import org.junit.Before;
@@ -45,6 +46,8 @@
 import static org.hamcrest.CoreMatchers.notNullValue;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThat;
+import static org.junit.Assert.fail;
+
 
 /**
  * @author as  2012.05.27
@@ -298,6 +301,27 @@ public void shouldInstrumentPackagelessClass() throws Exception
         MatcherAssert.assertThat(EvolvableObject.class.isAssignableFrom(instrumentedClass), is(true));
         }
 
+    @Test
+    public void shouldThrowErrorForFinalField() throws Exception
+        {
+        String         sClassName   = FinalFieldValue.class.getName();
+        URL            url          = getClass().getResource("/" + sClassName.replaceAll("\\.", "/") + ".class");
+        File           fileClass    = new File(url.toURI());
+        byte[]         abBytes      = Files.readAllBytes(fileClass.toPath());
+        Properties     properties   = new Properties();
+        Map<String, ?> env          = new HashMap<>();
+
+        try
+            {
+            PortableTypeGenerator.instrumentClass(fileClass, abBytes, 0, abBytes.length, properties, env);
+            fail("IllegalStateException should have been thrown");
+            }
+        catch (IllegalStateException ise)
+            {
+            // Expected
+            }
+        }
+
     // ----- inner class: ByteArrayClassLoader ------------------------------
 
     public static class ByteArrayClassLoader

prj/test/unit/coherence-tests/src/test/java/com/tangosol/io/pof/generator/data/FinalFieldValue.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.
+ *
+ * Licensed under the Universal Permissive License v 1.0 as shown at
+ * https://oss.oracle.com/licenses/upl.
+ */
+
+package com.tangosol.io.pof.generator.data;
+
+
+import com.tangosol.io.pof.schema.annotation.Portable;
+import com.tangosol.io.pof.schema.annotation.PortableType;
+import java.util.Objects;
+
+
+@PortableType(id = 1001)
+public class FinalFieldValue {
+
+    // ----- constructors ---------------------------------------------------
+
+    public FinalFieldValue(String sFinalField)
+        {
+        m_sFinalField = sFinalField;
+        }
+
+
+    // ----- accessors ------------------------------------------------------
+
+    public String getFinalField()
+        {
+        return m_sFinalField;
+        }
+
+
+    // ----- object methods -------------------------------------------------
+
+    @Override
+    public boolean equals(Object o)
+        {
+        if (this == o)
+            {
+            return true;
+            }
+        if (o == null || getClass() != o.getClass())
+            {
+            return false;
+            }
+        FinalFieldValue value = (FinalFieldValue) o;
+        return Objects.equals(m_sFinalField, value.m_sFinalField);
+        }
+
+    @Override
+    public int hashCode()
+        {
+        return Objects.hash(m_sFinalField);
+        }
+
+    @Override
+    public String toString()
+        {
+        return "FinalFieldValue{finalField='" + m_sFinalField + "'}";
+        }
+
+    // ----- data members ---------------------------------------------------
+
+    @Portable
+    final String m_sFinalField;
+}