Remove Message class, clean code and move validation to a separate class (does not validate yet)

Author: fdechelle

src/main/java/org/idmef/IDMEFObject.java

@@ -2,8 +2,11 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 
+import java.io.IOException;
 import java.lang.reflect.Array;
 import java.util.*;
 
@@ -28,34 +31,12 @@ public class IDMEFObject {
 
     private LinkedHashMap<String, Object> properties;
 
-    /**
-     * Construct an empty IDMEFObject.
-     */
-    public IDMEFObject(IDMEFObject parent, String propertyName)
-    {
-        properties = new LinkedHashMap<>();
-
-        if (parent != null)
-            parent.put(propertyName, this);
-    }
-
     /**
      * Construct an empty IDMEFObject.
      */
     public IDMEFObject()
     {
-        this(null, "");
-    }
-
-    /**
-     * Construct an IDMEFObject from a Map.
-     *
-     * @param map the Map
-     */
-    IDMEFObject(Map<String, Object> map) {
-        this();
-
-        properties.putAll(map);
+        properties = new LinkedHashMap<>();
     }
 
     private static Object convertField(JsonNode value) throws IDMEFException {
@@ -76,24 +57,18 @@ else if (value.isArray()) {
             throw new IDMEFException("Unhandled node type: " + value.getClass().getName());
     }
 
-    private void putFields(JsonNode node) throws IDMEFException {
+    IDMEFObject(JsonNode node) throws IDMEFException {
+        this();
+
         Iterator<Map.Entry<String, JsonNode>> fields = node.fields();
 
         while (fields.hasNext()) {
             Map.Entry<String, JsonNode> field = fields.next();
-            String key = field.getKey();
-            JsonNode value = field.getValue();
 
-            put(key, convertField(value));
+            put(field.getKey(), convertField(field.getValue()));
         }
     }
 
-    IDMEFObject(JsonNode node) throws IDMEFException {
-        this();
-
-        putFields(node);
-    }
-
     @JsonAnyGetter
     public Map<String, Object> getProperties() {
         return properties;
@@ -129,6 +104,41 @@ public Object put(String key, Object value) {
 
     @Override
     public boolean equals(Object obj) {
-        return properties.equals(obj);
+        if (! (obj instanceof IDMEFObject))
+            return false;
+
+        IDMEFObject idmefObject = (IDMEFObject) obj;
+
+        return properties.equals(idmefObject.properties);
+    }
+
+    /**
+     * Serialize a Message to JSON bytes.
+     *
+     * <b>Note: The method first validates the Message.</b>
+     *
+     * @return the JSON bytes
+     * @throws IDMEFException if the Message is not valid
+     */
+    public byte[] serialize() throws /* IDMEFException,*/ IOException {
+        //validate();
+
+        ObjectMapper objectMapper = new ObjectMapper();
+        objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
+
+        return objectMapper.writeValueAsBytes(this);
+    }
+
+    /**
+     * Deserialize JSON bytes to a Message
+     *
+     * @param json the JSON bytes
+     * @return a Message object with content filled from JSON
+     */
+    public static IDMEFObject deserialize(byte[] json) throws IOException {
+        ObjectMapper objectMapper = new ObjectMapper();
+
+        return objectMapper.readValue(json, IDMEFObject.class);
     }
+
 }

src/main/java/org/idmef/IDMEFValidator.java

@@ -0,0 +1,43 @@
+package org.idmef;
+
+import net.jimblackler.jsonschemafriend.*;
+
+import java.net.URL;
+
+public class IDMEFValidator {
+    private static final String SCHEMA_RESOURCE_PATH = "/IDMEFv2.schema";
+
+    /**
+     * Constructs an empty Message.
+     */
+    public IDMEFValidator() { }
+
+    /**
+     * Validate the Message content w.r.t. current IDMEF JSON schema.
+     *
+     * @throws IDMEFException if the Message is not valid.
+     */
+    public void validate(IDMEFObject idmefObject) throws IDMEFException {
+        URL r = IDMEFValidator.class.getResource(SCHEMA_RESOURCE_PATH);
+        if (r == null)
+            throw new IDMEFException("Cannot locate schema resource");
+
+        Schema schema;
+
+        SchemaStore schemaStore = new SchemaStore();
+        try {
+            schema = schemaStore.loadSchema(r);
+        } catch (GenerationException e) {
+            throw new IDMEFException("error loading schema:" + e.getMessage());
+        }
+
+        Validator validator = new Validator();
+
+        try {
+            validator.validate(schema, idmefObject);
+        } catch (ValidationException e) {
+            throw new IDMEFException("error validating:" + e.getMessage());
+        }
+    }
+
+}

src/main/java/org/idmef/Message.java

@@ -1,41 +1,34 @@
 import org.idmef.IDMEFObject;
-import org.idmef.Message;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.fail;
 
 public class TestDeserialize {
 
-    private static IDMEFObject deserialize(String json) {
+    private static void deserializeAndCheck(String json, IDMEFObject expected) {
         IDMEFObject msg = null;
 
         try {
-            msg = Message.deserialize(json.getBytes());
+            msg = IDMEFObject.deserialize(json.getBytes());
         } catch (Exception e) {
             fail(e.getMessage());
         }
 
-        return msg;
+        String[] propertiesToCheck = {"ID", "CreateTime", "Version"};
+
+        for (String property: propertiesToCheck) {
+            assertEquals(msg.get(property), expected.get(property));
+        }
     }
 
     @Test
     void testDeserializeMessage1() {
-        IDMEFObject msg = deserialize(Util.string1());
-
-        System.err.println("Message: " + msg.getProperties().getClass().getName());
-        System.err.println("Analyzer: " + msg.get("Analyzer").getClass().getName());
-
-        assertEquals(msg, Util.message1());
+        deserializeAndCheck(Util.string1(), Util.message1());
     }
 
     @Test
     void testDeserializeMessage2() {
-        IDMEFObject msg = deserialize(Util.string2());
-
-        System.err.println("Message: " + msg.getProperties().getClass().getName());
-        System.err.println("Sensor: " + msg.get("Sensor").getClass().getName());
-
-        assertEquals(msg, Util.message2());
+        deserializeAndCheck(Util.string2(), Util.message2());
     }
 }

src/test/java/TestDeserialize.java

@@ -1,4 +1,4 @@
-import org.idmef.Message;
+import org.idmef.IDMEFObject;
 import org.junit.jupiter.api.Test;
 
 import java.io.FileOutputStream;
@@ -7,7 +7,7 @@
 
 public class TestSerialize {
 
-    private static void serialize(Message msg, String outFileName) {
+    private static void serialize(IDMEFObject msg, String outFileName) {
         try {
             byte[] b = msg.serialize();
 

src/test/java/TestSerialize.java

@@ -1,19 +1,24 @@
-import org.idmef.Message;
+import org.idmef.IDMEFObject;
+import org.idmef.IDMEFValidator;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.fail;
 
 public class TestValidate {
 
-    @Test
-    void testValidateMessage1() {
-        Message m = Util.message1();
+    private static void validate(IDMEFObject idmefObject) {
+        IDMEFValidator validator = new IDMEFValidator();
 
         try {
-            m.validate();
+            validator.validate(idmefObject);
         } catch (Exception e) {
             fail(e.getMessage());
         }
     }
 
+    @Test
+    void testValidateMessage1() {
+        validate(Util.message1());
+    }
+
 }