1 files changed, 80 insertions, 0 deletions
diff --git a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/configserver/noderepository/reports/BaseReport.java b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/configserver/noderepository/reports/BaseReport.java
new file mode 100644
index 00000000000..26c1b90218f
--- /dev/null
+++ b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/configserver/noderepository/reports/BaseReport.java
@@ -0,0 +1,80 @@
+// Copyright 2019 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.vespa.hosted.node.admin.configserver.noderepository.reports;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonGetter;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import java.util.Objects;
+
+import static com.yahoo.yolean.Exceptions.uncheck;
+
+/**
+ * The most basic form of a node repository report on a node.
+ *
+ * <p>This class can be used directly for simple reports, or can be used as a base class for richer reports.
+ *
+ * <p><strong>Subclass requirements</strong>
+ *
+ * <ol>
+ *     <li>A subclass must maintain the property that {@link ObjectMapper} can map an instance to {@link JsonNode},
+ *     see {@link #toJsonNode()}.</li>
+ *     <li>A subclass must override {@link #updates(BaseReport)} and make sure to return false if
+ *     {@code !super.updates(current)}.</li>
+ * </ol>
+ *
+ * @author hakonhall
+ */
+// @Immutable
+@JsonIgnoreProperties(ignoreUnknown = true)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class BaseReport {
+    /** The time the report was created, in milliseconds since Epoch. */
+    public static final String CREATED_FIELD = "createdMillis";
+    /** The description of the error (implies wanting to fail out node). */
+    public static final String DESCRIPTION_FIELD = "description";
+
+    protected static final ObjectMapper mapper = new ObjectMapper();
+
+    private final Long createdMillis;
+    private final String description;
+
+    @JsonCreator
+    public BaseReport(@JsonProperty(CREATED_FIELD) Long createdMillisOrNull,
+                      @JsonProperty(DESCRIPTION_FIELD) String descriptionOrNull) {
+        this.createdMillis = createdMillisOrNull;
+        this.description = descriptionOrNull;
+
+    }
+
+    @JsonGetter(CREATED_FIELD)
+    public Long getCreatedMillisOrNull() {
+        return createdMillis;
+    }
+
+    @JsonGetter(DESCRIPTION_FIELD)
+    public String getDescriptionOrNull() {
+        return description;
+    }
+
+    /**
+     * Assume {@code this} is a freshly made report, and {@code current} is the report in the node repository:
+     * Return true iff the node repository should be updated.
+     *
+     * <p>The createdMillis field is ignored in this method (unless it is earlier than {@code current}'s?).
+     */
+    public boolean updates(BaseReport current) {
+        if (this == current) return false;
+        if (this.getClass() != current.getClass()) return true;
+        return !Objects.equals(description, current.description);
+    }
+
+    /** Returns {@code this} as a {@link JsonNode}. */
+    public JsonNode toJsonNode() {
+        return uncheck(() -> mapper.valueToTree(this));
+    }
+}