Module Sync Lock State implementation

[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / api / inventory / CompositeState.java

diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeState.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeState.java
index 9ac49a6..eeaa4cd 100644 (file)
--- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeState.java
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeState.java
@@ -22,6 +22,8 @@ package org.onap.cps.ncmp.api.inventory;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeFormatter;
 import lombok.Builder;
 import lombok.Data;
 import lombok.Getter;
@@ -38,7 +40,7 @@ import lombok.Setter;
 public class CompositeState {
 
     @JsonProperty("cm-handle-state")
-    private CmHandleState cmhandleState;
+    private CmHandleState cmHandleState;
 
     @JsonProperty("lock-reason")
     private LockReason lockReason;
@@ -52,13 +54,24 @@ public class CompositeState {
     @JsonProperty("datastores")
     private DataStores dataStores;
 
+    /**
+     * Date and Time in the format of yyyy-MM-dd'T'HH:mm:ss.SSSZ
+     */
+    public static final DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
+
+
+    /**
+     * This will specify the latest lock reason for a specific cm handle. If a cm handle is in a state other than LOCKED
+     * it specifies the last lock reason.
+     * This can be used to track retry attempts as part of the lock details.
+     */
     @Data
     @Builder
     @JsonInclude(JsonInclude.Include.NON_NULL)
     public static class LockReason {
 
         @JsonProperty("reason")
-        private String reason;
+        private LockReasonCategory lockReasonCategory;
 
         @JsonProperty("details")
         private String details;
@@ -72,9 +85,6 @@ public class CompositeState {
 
         @JsonProperty("operational")
         private Operational operationalDataStore;
-
-        @JsonProperty("running")
-        private Running runningDataStore;
     }
 
     @Data
@@ -101,4 +111,20 @@ public class CompositeState {
         private String lastSyncTime;
     }
 
+    /**
+     * The date and time format used for the cm handle sync state.
+     *
+     * @return the date and time in the format of yyyy-MM-dd'T'HH:mm:ss.SSSZ
+     */
+    public static String nowInSyncTimeFormat() {
+        return dateTimeFormatter.format(OffsetDateTime.now());
+    }
+
+    /**
+     * Sets the last updated date and time for the cm handle sync state.
+     */
+    public void setLastUpdateTimeNow() {
+        lastUpdateTime = CompositeState.nowInSyncTimeFormat();
+    }
+
 }