Merge pull request #160 from folio-org/MODWRKFLOW-69

MODWRKFLOW-69: Support checksums, created on date, and updated on date.

Author: kaladay

components/src/main/java/org/folio/rest/workflow/dto/WorkflowDto.java

@@ -1,16 +1,19 @@
 package org.folio.rest.workflow.dto;
 
+import org.folio.rest.workflow.model.has.HasChecksum;
+import org.folio.rest.workflow.model.has.HasCreatedOn;
 import org.folio.rest.workflow.model.has.HasDeploymentId;
 import org.folio.rest.workflow.model.has.HasId;
 import org.folio.rest.workflow.model.has.HasInformational;
 import org.folio.rest.workflow.model.has.HasName;
 import org.folio.rest.workflow.model.has.HasNodes;
+import org.folio.rest.workflow.model.has.HasUpdatedOn;
 import org.folio.rest.workflow.model.has.HasVersionTag;
 import org.folio.rest.workflow.model.has.common.HasWorkflowCommon;
 
 /**
  * This is a DTO design for providing the entire {@link org.folio.rest.workflow.model.Workflow Workflow} model.
  */
-public interface WorkflowDto extends HasDeploymentId, HasId, HasInformational, HasName, HasNodes, HasVersionTag, HasWorkflowCommon {
+public interface WorkflowDto extends HasChecksum, HasCreatedOn, HasDeploymentId, HasId, HasInformational, HasName, HasNodes, HasUpdatedOn, HasVersionTag, HasWorkflowCommon {
 
 }

components/src/main/java/org/folio/rest/workflow/model/Workflow.java

@@ -1,6 +1,7 @@
 package org.folio.rest.workflow.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import jakarta.annotation.Nullable;
 import jakarta.persistence.CollectionTable;
 import jakarta.persistence.Column;
 import jakarta.persistence.Convert;
@@ -15,16 +16,20 @@
 import jakarta.validation.constraints.Min;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
+import java.time.Instant;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import org.folio.rest.workflow.model.converter.JsonNodeConverter;
+import org.folio.rest.workflow.model.has.HasChecksum;
+import org.folio.rest.workflow.model.has.HasCreatedOn;
 import org.folio.rest.workflow.model.has.HasDeploymentId;
 import org.folio.rest.workflow.model.has.HasId;
 import org.folio.rest.workflow.model.has.HasInformational;
 import org.folio.rest.workflow.model.has.HasName;
 import org.folio.rest.workflow.model.has.HasNodes;
+import org.folio.rest.workflow.model.has.HasUpdatedOn;
 import org.folio.rest.workflow.model.has.HasVersionTag;
 import org.folio.rest.workflow.model.has.common.HasWorkflowCommon;
 import org.folio.spring.domain.model.AbstractBaseEntity;
@@ -34,12 +39,20 @@
 
 @Entity
 @JsonIgnoreProperties({ "hibernateLazyInitializer", "handler" })
-public class Workflow extends AbstractBaseEntity implements HasDeploymentId, HasId, HasInformational, HasName, HasNodes, HasVersionTag, HasWorkflowCommon {
+public class Workflow extends AbstractBaseEntity implements HasChecksum, HasCreatedOn, HasDeploymentId, HasId, HasInformational, HasName, HasNodes, HasUpdatedOn, HasVersionTag, HasWorkflowCommon {
 
   @Column(nullable = true)
   @ColumnDefault("false")
   private Boolean active;
 
+  @Nullable
+  @Column
+  private String checksum;
+
+  @NotNull
+  @Column(columnDefinition="TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()")
+  private Instant createdOn;
+
   @Column(unique = true)
   private String deploymentId;
 
@@ -70,6 +83,10 @@ public class Workflow extends AbstractBaseEntity implements HasDeploymentId, Has
   @Embedded
   private Setup setup;
 
+  @NotNull
+  @Column(columnDefinition="TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()")
+  private Instant updatedOn;
+
   @Version
   @NotNull
   @Size(min = 1, max = 64)
@@ -80,10 +97,13 @@ public Workflow() {
     super();
 
     active = false;
+    checksum = null;
+    createdOn = now();
     name = "";
     historyTimeToLive = 0;
     initialContext = new HashMap<>();
     nodes = new ArrayList<>();
+    updatedOn = now();
     versionTag = "1.0";
   }
 
@@ -93,6 +113,10 @@ public void prePersist() {
       active = false;
     }
 
+    if (createdOn == null) {
+      createdOn = now();
+    }
+
     if (historyTimeToLive == null) {
       historyTimeToLive = 0;
     }
@@ -109,6 +133,10 @@ public void prePersist() {
       nodes = new ArrayList<>();
     }
 
+    if (updatedOn == null) {
+      updatedOn = now();
+    }
+
     if (versionTag == null) {
       versionTag = "1.0";
     }
@@ -124,6 +152,16 @@ public Boolean getActive() {
     return active;
   }
 
+  @Override
+  public String getChecksum() {
+    return checksum;
+  }
+
+  @Override
+  public Instant getCreatedOn() {
+    return createdOn;
+  }
+
   @Override
   public Integer getHistoryTimeToLive() {
     return historyTimeToLive;
@@ -139,6 +177,11 @@ public Setup getSetup() {
     return setup;
   }
 
+  @Override
+  public Instant getUpdatedOn() {
+    return updatedOn;
+  }
+
   @Override
   public String getVersionTag() {
     return versionTag;
@@ -169,6 +212,16 @@ public void setActive(Boolean active) {
     this.active = active;
   }
 
+  @Override
+  public void setChecksum(String checksum) {
+    this.checksum = checksum;
+  }
+
+  @Override
+  public void setCreatedOn(Instant createdOn) {
+    this.createdOn = createdOn;
+  }
+
   @Override
   public void setHistoryTimeToLive(Integer historyTimeToLive) {
     this.historyTimeToLive = historyTimeToLive;
@@ -184,6 +237,11 @@ public void setSetup(Setup setup) {
     this.setup = setup;
   }
 
+  @Override
+  public void setUpdatedOn(Instant updatedOn) {
+    this.updatedOn = updatedOn;
+  }
+
   @Override
   public void setVersionTag(String versionTag) {
     this.versionTag = versionTag;
@@ -209,4 +267,16 @@ public void setDeploymentId(String deploymentId) {
     this.deploymentId = deploymentId;
   }
 
+  /**
+   * Get the current time.
+   *
+   * This is used to allow for easier unit testing where the unit tests need only override this method through mocks or similar.
+   *
+   * @return The current instant.
+   */
+  Instant now() {
+
+    return Instant.now();
+  }
+
 }

components/src/main/java/org/folio/rest/workflow/model/has/HasChecksum.java

@@ -0,0 +1,11 @@
+package org.folio.rest.workflow.model.has;
+
+/**
+ * This interface provides the Checksum methods.
+ */
+public interface HasChecksum {
+
+  public String getChecksum();
+
+  public void setChecksum(String checksum);
+}

components/src/main/java/org/folio/rest/workflow/model/has/HasCreatedOn.java

@@ -0,0 +1,13 @@
+package org.folio.rest.workflow.model.has;
+
+import java.time.Instant;
+
+/**
+ * This interface provides the CreatedOn methods.
+ */
+public interface HasCreatedOn {
+
+  public Instant getCreatedOn();
+
+  public void setCreatedOn(Instant createdOn);
+}

components/src/main/java/org/folio/rest/workflow/model/has/HasUpdatedOn.java

@@ -0,0 +1,13 @@
+package org.folio.rest.workflow.model.has;
+
+import java.time.Instant;
+
+/**
+ * This interface provides the UpdatedOn methods.
+ */
+public interface HasUpdatedOn {
+
+  public Instant getUpdatedOn();
+
+  public void setUpdatedOn(Instant updatedOn);
+}