cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/yangmodels/YangModelCmHandle.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 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
  22 package org.onap.cps.ncmp.api.impl.yangmodels;
  23
  24 import com.fasterxml.jackson.annotation.JsonInclude;
  25 import com.fasterxml.jackson.annotation.JsonInclude.Include;
  26 import com.fasterxml.jackson.annotation.JsonProperty;
  27 import com.google.common.base.Strings;
  28 import java.util.ArrayList;
  29 import java.util.List;
  30 import java.util.Map;
  31 import lombok.AllArgsConstructor;
  32 import lombok.Data;
  33 import lombok.EqualsAndHashCode;
  34 import lombok.Getter;
  35 import lombok.NoArgsConstructor;
  36 import lombok.Setter;
  37 import org.onap.cps.ncmp.api.impl.inventory.CompositeState;
  38 import org.onap.cps.ncmp.api.impl.operations.RequiredDmiService;
  39 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  40
  41 /**
  42  * Cm Handle which follows the Yang resource dmi registry model when persisting data to DMI or the DB.
  43  * Yang model CmHandle
  44  */
  45 @Getter
  46 @Setter
  47 @NoArgsConstructor
  48 @JsonInclude(Include.NON_NULL)
  49 @EqualsAndHashCode(onlyExplicitlyIncluded = true)
  50 public class YangModelCmHandle {
  51
  52     @EqualsAndHashCode.Include
  53     private String id;
  54
  55     @JsonProperty("dmi-service-name")
  56     private String dmiServiceName;
  57
  58     @JsonProperty("dmi-data-service-name")
  59     private String dmiDataServiceName;
  60
  61     @JsonProperty("state")
  62     private CompositeState compositeState;
  63
  64     @JsonProperty("dmi-model-service-name")
  65     private String dmiModelServiceName;
  66
  67     @JsonProperty("module-set-tag")
  68     private String moduleSetTag;
  69
  70     @JsonProperty("additional-properties")
  71     private List<Property> dmiProperties;
  72
  73     @JsonProperty("public-properties")
  74     private List<Property> publicProperties;
  75
  76     /**
  77      * Creates a deep copy of Yang Model Cm Handle.
  78      *
  79      * @param original Yang Model Cm Handle
  80      * @return instance of yangModelCmHandle
  81      */
  82     public static YangModelCmHandle deepCopyOf(final YangModelCmHandle original) {
  83         final YangModelCmHandle copy = new YangModelCmHandle();
  84         copy.id = original.getId();
  85         copy.dmiServiceName = original.getDmiServiceName();
  86         copy.dmiDataServiceName = original.getDmiDataServiceName();
  87         copy.dmiModelServiceName = original.getDmiModelServiceName();
  88         copy.compositeState =
  89                 original.getCompositeState() == null ? null : new CompositeState(original.getCompositeState());
  90         copy.dmiProperties = original.getDmiProperties() == null ? null : new ArrayList<>(original.getDmiProperties());
  91         copy.publicProperties =
  92                 original.getPublicProperties() == null ? null : new ArrayList<>(original.getPublicProperties());
  93         return copy;
  94     }
  95
  96     /**
  97      * Create a yangModelCmHandle.
  98      *
  99      * @param dmiServiceName      dmi service name
 100      * @param dmiDataServiceName  dmi data service name
 101      * @param dmiModelServiceName dmi model service name
 102      * @param ncmpServiceCmHandle the cm handle
 103      * @return instance of yangModelCmHandle
 104      */
 105     public static YangModelCmHandle toYangModelCmHandle(final String dmiServiceName,
 106                                                         final String dmiDataServiceName,
 107                                                         final String dmiModelServiceName,
 108                                                         final NcmpServiceCmHandle ncmpServiceCmHandle,
 109                                                         final String moduleSetTag) {
 110         final YangModelCmHandle yangModelCmHandle = new YangModelCmHandle();
 111         yangModelCmHandle.setId(ncmpServiceCmHandle.getCmHandleId());
 112         yangModelCmHandle.setDmiServiceName(dmiServiceName);
 113         yangModelCmHandle.setDmiDataServiceName(dmiDataServiceName);
 114         yangModelCmHandle.setDmiModelServiceName(dmiModelServiceName);
 115         yangModelCmHandle.setModuleSetTag(moduleSetTag);
 116         yangModelCmHandle.setDmiProperties(asYangModelCmHandleProperties(ncmpServiceCmHandle.getDmiProperties()));
 117         yangModelCmHandle.setPublicProperties(asYangModelCmHandleProperties(
 118                 ncmpServiceCmHandle.getPublicProperties()));
 119         yangModelCmHandle.setCompositeState(ncmpServiceCmHandle.getCompositeState());
 120         return yangModelCmHandle;
 121     }
 122
 123     /**
 124      * Resolve a dmi service name.
 125      *
 126      * @param requiredService indicates what typo of service is required
 127      * @return dmi service name
 128      */
 129     public String resolveDmiServiceName(final RequiredDmiService requiredService) {
 130         if (isNullEmptyOrBlank(dmiServiceName)) {
 131             if (RequiredDmiService.DATA.equals(requiredService)) {
 132                 return dmiDataServiceName;
 133             }
 134             return dmiModelServiceName;
 135         }
 136         return dmiServiceName;
 137     }
 138
 139     private static List<Property> asYangModelCmHandleProperties(final Map<String, String> propertiesAsMap) {
 140         final List<Property> yangModelCmHandleProperties = new ArrayList<>(propertiesAsMap.size());
 141         for (final Map.Entry<String, String> entry : propertiesAsMap.entrySet()) {
 142             yangModelCmHandleProperties.add(new YangModelCmHandle.Property(entry.getKey(), entry.getValue()));
 143         }
 144         return yangModelCmHandleProperties;
 145     }
 146
 147     private static boolean isNullEmptyOrBlank(final String serviceName) {
 148         return Strings.isNullOrEmpty(serviceName) || serviceName.isBlank();
 149     }
 150
 151     @AllArgsConstructor
 152     @Data
 153     public static class Property {
 154
 155         @JsonProperty()
 156         private final String name;
 157
 158         @JsonProperty()
 159         private final String value;
 160     }
 161
 162 }