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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2024 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("alternate-id")
  72     private String alternateId;
  73
  74     @JsonProperty("additional-properties")
  75     private List<Property> dmiProperties;
  76
  77     @JsonProperty("public-properties")
  78     private List<Property> publicProperties;
  79
  80     /**
  81      * Creates a deep copy of Yang Model Cm Handle.
  82      *
  83      * @param original Yang Model Cm Handle
  84      * @return instance of yangModelCmHandle
  85      */
  86     public static YangModelCmHandle deepCopyOf(final YangModelCmHandle original) {
  87         final YangModelCmHandle copy = new YangModelCmHandle();
  88         copy.id = original.getId();
  89         copy.dmiServiceName = original.getDmiServiceName();
  90         copy.dmiDataServiceName = original.getDmiDataServiceName();
  91         copy.dmiModelServiceName = original.getDmiModelServiceName();
  92         copy.compositeState =
  93                 original.getCompositeState() == null ? null : new CompositeState(original.getCompositeState());
  94         copy.dmiProperties = original.getDmiProperties() == null ? null : new ArrayList<>(original.getDmiProperties());
  95         copy.publicProperties =
  96                 original.getPublicProperties() == null ? null : new ArrayList<>(original.getPublicProperties());
  97         copy.alternateId = original.getAlternateId();
  98         return copy;
  99     }
 100
 101     /**
 102      * Create a yangModelCmHandle.
 103      *
 104      * @param dmiServiceName      dmi service name
 105      * @param dmiDataServiceName  dmi data service name
 106      * @param dmiModelServiceName dmi model service name
 107      * @param ncmpServiceCmHandle the cm handle
 108      * @return instance of yangModelCmHandle
 109      */
 110     public static YangModelCmHandle toYangModelCmHandle(final String dmiServiceName,
 111                                                         final String dmiDataServiceName,
 112                                                         final String dmiModelServiceName,
 113                                                         final NcmpServiceCmHandle ncmpServiceCmHandle,
 114                                                         final String moduleSetTag,
 115                                                         final String alternateId) {
 116         final YangModelCmHandle yangModelCmHandle = new YangModelCmHandle();
 117         yangModelCmHandle.setId(ncmpServiceCmHandle.getCmHandleId());
 118         yangModelCmHandle.setDmiServiceName(dmiServiceName);
 119         yangModelCmHandle.setDmiDataServiceName(dmiDataServiceName);
 120         yangModelCmHandle.setDmiModelServiceName(dmiModelServiceName);
 121         yangModelCmHandle.setModuleSetTag(moduleSetTag == null ? StringUtils.EMPTY : moduleSetTag);
 122         yangModelCmHandle.setAlternateId(alternateId == null ? StringUtils.EMPTY : alternateId);
 123         yangModelCmHandle.setDmiProperties(asYangModelCmHandleProperties(ncmpServiceCmHandle.getDmiProperties()));
 124         yangModelCmHandle.setPublicProperties(asYangModelCmHandleProperties(
 125                 ncmpServiceCmHandle.getPublicProperties()));
 126         yangModelCmHandle.setCompositeState(ncmpServiceCmHandle.getCompositeState());
 127         return yangModelCmHandle;
 128     }
 129
 130     /**
 131      * Resolve a dmi service name.
 132      *
 133      * @param requiredService indicates what typo of service is required
 134      * @return dmi service name
 135      */
 136     public String resolveDmiServiceName(final RequiredDmiService requiredService) {
 137         if (isNullEmptyOrBlank(dmiServiceName)) {
 138             if (RequiredDmiService.DATA.equals(requiredService)) {
 139                 return dmiDataServiceName;
 140             }
 141             return dmiModelServiceName;
 142         }
 143         return dmiServiceName;
 144     }
 145
 146     private static List<Property> asYangModelCmHandleProperties(final Map<String, String> propertiesAsMap) {
 147         final List<Property> yangModelCmHandleProperties = new ArrayList<>(propertiesAsMap.size());
 148         for (final Map.Entry<String, String> entry : propertiesAsMap.entrySet()) {
 149             yangModelCmHandleProperties.add(new YangModelCmHandle.Property(entry.getKey(), entry.getValue()));
 150         }
 151         return yangModelCmHandleProperties;
 152     }
 153
 154     private static boolean isNullEmptyOrBlank(final String serviceName) {
 155         return Strings.isNullOrEmpty(serviceName) || serviceName.isBlank();
 156     }
 157
 158     @AllArgsConstructor
 159     @Data
 160     public static class Property {
 161
 162         @JsonProperty()
 163         private final String name;
 164
 165         @JsonProperty()
 166         private final String value;
 167     }
 168
 169 }