Fix serialization issues in RatingInfluencers and Recommendations

- Made RatingInfluencer and Recommendation classes implement Serializable
- Made PropertyResultRatingInfluencer and PropertyResultRecommendation implement Serializable
- Made AnalyzedProperty and AnalyzedPropertyCategory interfaces extend Serializable
- Added SerializationTest to verify serialization works correctly

This fixes SpotBugs warnings about non-transient non-serializable fields in serializable classes.

Author: Developer

src/main/java/de/rub/nds/scanner/core/probe/AnalyzedProperty.java

@@ -13,11 +13,12 @@
 import jakarta.xml.bind.annotation.XmlAccessType;
 import jakarta.xml.bind.annotation.XmlAccessorType;
 import jakarta.xml.bind.annotation.XmlRootElement;
+import java.io.Serializable;
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
-public interface AnalyzedProperty {
+public interface AnalyzedProperty extends Serializable {
 
     AnalyzedPropertyCategory getCategory();
 

src/main/java/de/rub/nds/scanner/core/probe/AnalyzedPropertyCategory.java

@@ -11,7 +11,8 @@
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import jakarta.xml.bind.annotation.XmlAccessType;
 import jakarta.xml.bind.annotation.XmlAccessorType;
+import java.io.Serializable;
 
 @XmlAccessorType(XmlAccessType.FIELD)
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
-public interface AnalyzedPropertyCategory {}
+public interface AnalyzedPropertyCategory extends Serializable {}

src/main/java/de/rub/nds/scanner/core/report/rating/PropertyResultRatingInfluencer.java

@@ -18,6 +18,7 @@
 import jakarta.xml.bind.annotation.XmlElement;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import jakarta.xml.bind.annotation.XmlType;
+import java.io.Serializable;
 import java.util.Objects;
 
 @XmlRootElement
@@ -30,7 +31,8 @@
             "referencedProperty",
             "referencedPropertyResult"
         })
-public class PropertyResultRatingInfluencer implements Comparable<PropertyResultRatingInfluencer> {
+public class PropertyResultRatingInfluencer
+        implements Comparable<PropertyResultRatingInfluencer>, Serializable {
 
     @XmlElement(type = TestResults.class, name = "result")
     @JsonIgnore

src/main/java/de/rub/nds/scanner/core/report/rating/PropertyResultRecommendation.java

@@ -15,11 +15,12 @@
 import jakarta.xml.bind.annotation.XmlAnyElement;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import jakarta.xml.bind.annotation.XmlSeeAlso;
+import java.io.Serializable;
 
 @XmlRootElement
 @XmlSeeAlso({TestResults.class})
 @XmlAccessorType(XmlAccessType.FIELD)
-public class PropertyResultRecommendation {
+public class PropertyResultRecommendation implements Serializable {
 
     @XmlAnyElement(lax = true)
     private TestResult result;

src/main/java/de/rub/nds/scanner/core/report/rating/RatingInfluencer.java

@@ -11,13 +11,14 @@
 import de.rub.nds.scanner.core.probe.AnalyzedProperty;
 import de.rub.nds.scanner.core.probe.result.TestResult;
 import jakarta.xml.bind.annotation.*;
+import java.io.Serializable;
 import java.util.Arrays;
 import java.util.LinkedList;
 import java.util.List;
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class RatingInfluencer {
+public class RatingInfluencer implements Serializable {
 
     @XmlAnyElement(lax = true)
     private AnalyzedProperty analyzedProperty;

src/main/java/de/rub/nds/scanner/core/report/rating/Recommendation.java

@@ -15,6 +15,7 @@
 import jakarta.xml.bind.annotation.XmlAnyElement;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import jakarta.xml.bind.annotation.XmlType;
+import java.io.Serializable;
 import java.util.Arrays;
 import java.util.LinkedList;
 import java.util.List;
@@ -31,7 +32,7 @@
             "propertyRecommendations"
         })
 @XmlAccessorType(XmlAccessType.FIELD)
-public class Recommendation {
+public class Recommendation implements Serializable {
 
     static final String NO_INFORMATION_FOUND = "No detailed information available";
 

src/test/java/de/rub/nds/scanner/core/report/rating/SerializationTest.java

@@ -0,0 +1,124 @@
+/*
+ * Scanner Core - A Modular Framework for Probe Definition, Execution, and Result Analysis.
+ *
+ * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, Technology Innovation Institute, and Hackmanit GmbH
+ *
+ * Licensed under Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0.txt
+ */
+package de.rub.nds.scanner.core.report.rating;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import de.rub.nds.scanner.core.probe.AnalyzedProperty;
+import de.rub.nds.scanner.core.probe.AnalyzedPropertyCategory;
+import de.rub.nds.scanner.core.probe.result.TestResults;
+import java.io.*;
+import java.util.Arrays;
+import java.util.LinkedList;
+import java.util.List;
+import org.junit.jupiter.api.Test;
+
+public class SerializationTest {
+
+    private static class TestPropertyCategory implements AnalyzedPropertyCategory {
+        private static final long serialVersionUID = 1L;
+    }
+
+    private static class TestProperty implements AnalyzedProperty {
+        private static final long serialVersionUID = 1L;
+        private final String name;
+
+        public TestProperty(String name) {
+            this.name = name;
+        }
+
+        @Override
+        public AnalyzedPropertyCategory getCategory() {
+            return new TestPropertyCategory();
+        }
+
+        @Override
+        public String getName() {
+            return name;
+        }
+    }
+
+    @Test
+    public void testRatingInfluencersSerialization() throws IOException, ClassNotFoundException {
+        // Create test data
+        TestProperty property = new TestProperty("TEST_PROPERTY");
+        PropertyResultRatingInfluencer influencer1 =
+                new PropertyResultRatingInfluencer(TestResults.TRUE, 10);
+        PropertyResultRatingInfluencer influencer2 =
+                new PropertyResultRatingInfluencer(TestResults.FALSE, -5);
+        List<PropertyResultRatingInfluencer> influencerList =
+                Arrays.asList(influencer1, influencer2);
+
+        RatingInfluencer ratingInfluencer = new RatingInfluencer(property, influencerList);
+        LinkedList<RatingInfluencer> ratingInfluencersList = new LinkedList<>();
+        ratingInfluencersList.add(ratingInfluencer);
+
+        RatingInfluencers ratingInfluencers = new RatingInfluencers(ratingInfluencersList);
+
+        // Serialize
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        ObjectOutputStream oos = new ObjectOutputStream(baos);
+        oos.writeObject(ratingInfluencers);
+        oos.close();
+
+        // Deserialize
+        ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
+        ObjectInputStream ois = new ObjectInputStream(bais);
+        RatingInfluencers deserialized = (RatingInfluencers) ois.readObject();
+        ois.close();
+
+        // Verify
+        assertNotNull(deserialized);
+        assertNotNull(deserialized.getRatingInfluencers());
+        assertEquals(1, deserialized.getRatingInfluencers().size());
+    }
+
+    @Test
+    public void testRecommendationsSerialization() throws IOException, ClassNotFoundException {
+        // Create test data
+        TestProperty property = new TestProperty("TEST_PROPERTY");
+        PropertyResultRecommendation recommendation1 =
+                new PropertyResultRecommendation(
+                        TestResults.TRUE, "Short desc", "Handling recommendation");
+        PropertyResultRecommendation recommendation2 =
+                new PropertyResultRecommendation(
+                        TestResults.FALSE, "Another desc", "Another recommendation");
+
+        Recommendation recommendation =
+                new Recommendation(
+                        property,
+                        "Test Recommendation",
+                        "Short description",
+                        "Detailed description",
+                        recommendation1,
+                        "https://example.com");
+        recommendation.getPropertyRecommendations().add(recommendation2);
+
+        List<Recommendation> recommendationList = Arrays.asList(recommendation);
+        Recommendations recommendations = new Recommendations(recommendationList);
+
+        // Serialize
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        ObjectOutputStream oos = new ObjectOutputStream(baos);
+        oos.writeObject(recommendations);
+        oos.close();
+
+        // Deserialize
+        ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
+        ObjectInputStream ois = new ObjectInputStream(bais);
+        Recommendations deserialized = (Recommendations) ois.readObject();
+        ois.close();
+
+        // Verify
+        assertNotNull(deserialized);
+        assertNotNull(deserialized.getRecommendations());
+        assertEquals(1, deserialized.getRecommendations().size());
+    }
+}