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