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

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2022 Nordix Foundation
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.api.inventory;
  22
  23 import com.fasterxml.jackson.annotation.JsonInclude;
  24 import com.fasterxml.jackson.annotation.JsonProperty;
  25 import java.time.OffsetDateTime;
  26 import java.time.format.DateTimeFormatter;
  27 import lombok.Builder;
  28 import lombok.Data;
  29 import lombok.Getter;
  30 import lombok.NoArgsConstructor;
  31 import lombok.Setter;
  32
  33 /**
  34  * State Model to store state corresponding to the Yang resource dmi-registry model.
  35  */
  36 @Getter
  37 @Setter
  38 @NoArgsConstructor
  39 @JsonInclude(JsonInclude.Include.NON_NULL)
  40 public class CompositeState {
  41
  42     @JsonProperty("cm-handle-state")
  43     private CmHandleState cmHandleState;
  44
  45     @JsonProperty("lock-reason")
  46     private LockReason lockReason;
  47
  48     @JsonProperty("last-update-time")
  49     private String lastUpdateTime;
  50
  51     @JsonProperty("data-sync-enabled")
  52     private Boolean dataSyncEnabled;
  53
  54     @JsonProperty("datastores")
  55     private DataStores dataStores;
  56
  57     /**
  58      * Date and Time in the format of yyyy-MM-dd'T'HH:mm:ss.SSSZ
  59      */
  60     public static final DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
  61
  62
  63     /**
  64      * This will specify the latest lock reason for a specific cm handle. If a cm handle is in a state other than LOCKED
  65      * it specifies the last lock reason.
  66      * This can be used to track retry attempts as part of the lock details.
  67      */
  68     @Data
  69     @Builder
  70     @JsonInclude(JsonInclude.Include.NON_NULL)
  71     public static class LockReason {
  72
  73         @JsonProperty("reason")
  74         private LockReasonCategory lockReasonCategory;
  75
  76         @JsonProperty("details")
  77         private String details;
  78
  79     }
  80
  81     @Data
  82     @Builder
  83     @JsonInclude(JsonInclude.Include.NON_NULL)
  84     public static class DataStores {
  85
  86         @JsonProperty("operational")
  87         private Operational operationalDataStore;
  88     }
  89
  90     @Data
  91     @Builder
  92     @JsonInclude(JsonInclude.Include.NON_NULL)
  93     public static class Operational {
  94
  95         @JsonProperty("sync-state")
  96         private String syncState;
  97
  98         @JsonProperty("last-sync-time")
  99         private String lastSyncTime;
 100     }
 101
 102     @Data
 103     @Builder
 104     @JsonInclude(JsonInclude.Include.NON_NULL)
 105     public static class Running {
 106
 107         @JsonProperty("sync-state")
 108         private String syncState;
 109
 110         @JsonProperty("last-sync-time")
 111         private String lastSyncTime;
 112     }
 113
 114     /**
 115      * The date and time format used for the cm handle sync state.
 116      *
 117      * @return the date and time in the format of yyyy-MM-dd'T'HH:mm:ss.SSSZ
 118      */
 119     public static String nowInSyncTimeFormat() {
 120         return dateTimeFormatter.format(OffsetDateTime.now());
 121     }
 122
 123     /**
 124      * Sets the last updated date and time for the cm handle sync state.
 125      */
 126     public void setLastUpdateTimeNow() {
 127         lastUpdateTime = CompositeState.nowInSyncTimeFormat();
 128     }
 129
 130 }