Move StatusValue.Events to an enum class

Identified the media type that is being stored in the database. Instead of detecting if data is json or xml, instead base it on the media type for the event.
geonetwork · Jan 6, 2025 · 963c7b3 · 963c7b3
1 parent 490e6b9
commit 963c7b3
Show file tree

Hide file tree

Showing 15 changed files with 193 additions and 82 deletions.
diff --git a/domain/src/main/java/org/fao/geonet/domain/StatusValue.java b/domain/src/main/java/org/fao/geonet/domain/StatusValue.java
@@ -24,9 +24,11 @@
 package org.fao.geonet.domain;
 
 import org.fao.geonet.entitylistener.StatusValueEntityListenerManager;
+import org.springframework.http.MediaType;
 
 import javax.persistence.*;
 
+import java.util.Arrays;
 import java.util.Map;
 
 /**
@@ -223,20 +225,141 @@ public static final class Status {
      * List of predefined status part of the events. Those values are the default
      * one for GeoNetwork and may be modified in the database.
      */
-    public static final class Events {
-        public static final String RECORDCREATED = "50";
-        public static final String RECORDUPDATED = "51";
-        public static final String ATTACHMENTADDED = "52";
-        public static final String ATTACHMENTDELETED = "53";
-        public static final String RECORDOWNERCHANGE = "54";
-        public static final String RECORDGROUPOWNERCHANGE = "55";
-        public static final String RECORDPRIVILEGESCHANGE = "56";
-        public static final String RECORDCATEGORYCHANGE = "57";
-        public static final String RECORDVALIDATIONTRIGGERED = "58";
-        public static final String RECORDSTATUSCHANGE = "59";
-        public static final String RECORDPROCESSINGCHANGE = "60";
-        public static final String RECORDDELETED = "61";
-        public static final String RECORDIMPORTED = "62";
-        public static final String RECORDRESTORED = "63";
+    public enum Events {
+        RECORDCREATED(50, false, MediaType.APPLICATION_JSON, null),
+        RECORDUPDATED(51, true, MediaType.APPLICATION_XML, MediaType.APPLICATION_XML),
+        ATTACHMENTADDED(52, false, MediaType.TEXT_PLAIN, null),
+        ATTACHMENTDELETED(53, false, null, MediaType.TEXT_PLAIN),
+        RECORDOWNERCHANGE(54, false, MediaType.APPLICATION_JSON, MediaType.APPLICATION_JSON),
+        RECORDGROUPOWNERCHANGE(55, false, MediaType.APPLICATION_JSON, MediaType.APPLICATION_JSON),
+        RECORDPRIVILEGESCHANGE(56, false, MediaType.APPLICATION_JSON, MediaType.APPLICATION_JSON),
+        RECORDCATEGORYCHANGE(57, false, MediaType.APPLICATION_JSON, MediaType.APPLICATION_JSON),
+        RECORDVALIDATIONTRIGGERED(58, false, MediaType.TEXT_PLAIN, null),
+        RECORDSTATUSCHANGE(59, false, MediaType.APPLICATION_JSON, MediaType.APPLICATION_JSON),
+        RECORDPROCESSINGCHANGE(60, true, MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML),
+        RECORDDELETED(61, true, null, MediaType.APPLICATION_XML),
+        RECORDIMPORTED(62, false, MediaType.APPLICATION_JSON, null),
+        RECORDRESTORED(63, true, MediaType.APPLICATION_XML, MediaType.APPLICATION_XML);
+
+        /**
+         * The id of the event.
+         */
+        private final Integer id;
+        /**
+         * The restore function currently supports these states
+         */
+        private final boolean isSupportedRestoreStatus;
+
+        /**
+         * Indicates mime type of the current state will be stored in.
+         * This is generally json or xml and if it is null then the state is not supported.
+         */
+        private final MediaType currentStateFormat;
+
+        /**
+         * Indicates mime type of the previous state will be stored in.
+         * This is generally json or xml and if it is null then the state is not supported.
+         */
+        private final MediaType previousStateFormat;
+
+        /**
+         * Constructor.
+         *
+         * @param id the id of the event.
+         * @param isSupportedRestoreStatus the restore function currently supports these states.
+         * @param currentStateFormat indicates mime type of the current state will be stored in.
+         * @param previousStateFormat indicates mime type of the current state will be stored in.
+         */
+        Events(Integer id, boolean isSupportedRestoreStatus, MediaType currentStateFormat, MediaType previousStateFormat) {
+            this.id = id;
+            this.isSupportedRestoreStatus = isSupportedRestoreStatus;
+            this.currentStateFormat = currentStateFormat;
+            this.previousStateFormat = previousStateFormat;
+        }
+
+        /**
+         * Get the id of the event.
+         *
+         * @return the id of the event.
+         */
+        public Integer getId() {
+            return id;
+        }
+
+        /**
+         * Get the event from the id.
+         *
+         * @param id the id of the event.
+         * @return the event.
+         */
+        public static Events fromId(Integer id) {
+            return Arrays.stream(values())
+                .filter(event -> event.getId().equals(id))
+                .findFirst()
+                .orElseThrow(() -> new IllegalArgumentException("No event found with id: " + id));
+        }
+
+        /**
+         * Get the code of the event.
+         * The code currently is the string representation of the id.
+         *
+         * @return the code of the event.
+         */
+        public String getCode() {
+            return String.valueOf(id);
+        }
+
+        /**
+         * Get the event from the code.
+         *
+         * @param code the code of the event.
+         * @return the event.
+         */
+        public static Events fromCode(String code) {
+            return Arrays.stream(values())
+                .filter(event -> event.getCode().equals(code))
+                .findFirst()
+                .orElseThrow(() -> new IllegalArgumentException("No event found with code: " + code));
+        }
+
+        /**
+         * Get the mime type of the current state will be stored in.
+         *
+         * @return the mime type of the current state will be stored in.
+         */
+        public MediaType getCurrentStateFormat() {
+            return currentStateFormat;
+        }
+
+        /**
+         * Get the mime type of the previous state will be stored in.
+         *
+         * @return the mime type of the previous state will be stored in.
+         */
+        public MediaType getPreviousStateFormat() {
+            return previousStateFormat;
+        }
+
+        /**
+         * Identify if the current status supports restoring the values.
+         * This is mostly for restoring xml metadata records.
+         *
+         * @return true if supported.
+         */
+        public boolean isSupportedRestoreStatus() {
+            return isSupportedRestoreStatus;
+        }
+
+        /**
+         * Get an array of the event that support restoring statuses.
+         * This is mostly for restoring xml metadata records.
+         *
+         * @return list of events with isSupportedRestoreStatus set to true.
+         */
+        public static Events[] getSupportedRestoreStatuses() {
+            return Arrays.stream(values())
+                .filter(Events::isSupportedRestoreStatus)
+                .toArray(Events[]::new);
+        }
     }
 }
diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/AttachmentAddedListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/AttachmentAddedListener.java
@@ -31,7 +31,7 @@
 public class AttachmentAddedListener extends GenericMetadataEventListener implements ApplicationListener<AttachmentAddedEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.ATTACHMENTADDED;
+    private final StatusValue.Events eventType = StatusValue.Events.ATTACHMENTADDED;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/AttachmentDeletedListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/AttachmentDeletedListener.java
@@ -31,7 +31,7 @@
 public class AttachmentDeletedListener extends GenericMetadataEventListener implements ApplicationListener<AttachmentDeletedEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.ATTACHMENTDELETED;
+    private final StatusValue.Events eventType = StatusValue.Events.ATTACHMENTDELETED;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordCategoryChangeListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordCategoryChangeListener.java
@@ -31,7 +31,7 @@
 public class RecordCategoryChangeListener extends GenericMetadataEventListener implements ApplicationListener<RecordCategoryChangeEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDCATEGORYCHANGE;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDCATEGORYCHANGE;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordCreatedListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordCreatedListener.java
@@ -31,7 +31,7 @@
 public class RecordCreatedListener extends GenericMetadataEventListener implements ApplicationListener<RecordCreateEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDCREATED;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDCREATED;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordDeletedListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordDeletedListener.java
@@ -31,7 +31,7 @@
 public class RecordDeletedListener extends GenericMetadataEventListener implements ApplicationListener<RecordDeletedEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDDELETED;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDDELETED;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordGroupOwnerChangeListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordGroupOwnerChangeListener.java
@@ -32,7 +32,7 @@ public class RecordGroupOwnerChangeListener extends GenericMetadataEventListener
         implements ApplicationListener<RecordGroupOwnerChangeEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDGROUPOWNERCHANGE;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDGROUPOWNERCHANGE;
 
     @Override
     public String getChangeMessage() {
@@ -41,7 +41,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordImportedListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordImportedListener.java
@@ -31,7 +31,7 @@
 public class RecordImportedListener extends GenericMetadataEventListener implements ApplicationListener<RecordImportedEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDIMPORTED;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDIMPORTED;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordOwnerChangeListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordOwnerChangeListener.java
@@ -31,7 +31,7 @@
 public class RecordOwnerChangeListener extends GenericMetadataEventListener implements ApplicationListener<RecordOwnerChangeEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDOWNERCHANGE;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDOWNERCHANGE;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordPrivilegesChangeListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordPrivilegesChangeListener.java
@@ -32,7 +32,7 @@ public class RecordPrivilegesChangeListener extends GenericMetadataEventListener
         implements ApplicationListener<RecordPrivilegesChangeEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDPRIVILEGESCHANGE;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDPRIVILEGESCHANGE;
 
     @Override
     public String getChangeMessage() {
@@ -41,7 +41,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordProcessingChangeListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordProcessingChangeListener.java
@@ -32,7 +32,7 @@ public class RecordProcessingChangeListener extends GenericMetadataEventListener
         implements ApplicationListener<RecordProcessingChangeEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDPROCESSINGCHANGE;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDPROCESSINGCHANGE;
 
     @Override
     public String getChangeMessage() {
@@ -41,7 +41,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordRestoredListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordRestoredListener.java
@@ -31,7 +31,7 @@
 public class RecordRestoredListener extends GenericMetadataEventListener implements ApplicationListener<RecordRestoredEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDRESTORED;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDRESTORED;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override

diff --git a/listeners/src/main/java/org/fao/geonet/listener/history/RecordUpdatedListener.java b/listeners/src/main/java/org/fao/geonet/listener/history/RecordUpdatedListener.java
@@ -31,7 +31,7 @@
 public class RecordUpdatedListener extends GenericMetadataEventListener implements ApplicationListener<RecordUpdatedEvent> {
 
     private String changeMessage = "";
-    private String eventType = StatusValue.Events.RECORDUPDATED;
+    private final StatusValue.Events eventType = StatusValue.Events.RECORDUPDATED;
 
     @Override
     public String getChangeMessage() {
@@ -40,7 +40,7 @@ public String getChangeMessage() {
 
     @Override
     public String getEventType() {
-        return eventType;
+        return eventType.getCode();
     }
 
     @Override