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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.api.impl.yangmodels;
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;
31 import lombok.AllArgsConstructor;
33 import lombok.EqualsAndHashCode;
35 import lombok.NoArgsConstructor;
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;
42 * Cm Handle which follows the Yang resource dmi registry model when persisting data to DMI or the DB.
48 @JsonInclude(Include.NON_NULL)
49 @EqualsAndHashCode(onlyExplicitlyIncluded = true)
50 public class YangModelCmHandle {
52 @EqualsAndHashCode.Include
55 @JsonProperty("dmi-service-name")
56 private String dmiServiceName;
58 @JsonProperty("dmi-data-service-name")
59 private String dmiDataServiceName;
61 @JsonProperty("state")
62 private CompositeState compositeState;
64 @JsonProperty("dmi-model-service-name")
65 private String dmiModelServiceName;
67 @JsonProperty("module-set-tag")
68 private String moduleSetTag;
70 @JsonProperty("additional-properties")
71 private List<Property> dmiProperties;
73 @JsonProperty("public-properties")
74 private List<Property> publicProperties;
77 * Creates a deep copy of Yang Model Cm Handle.
79 * @param original Yang Model Cm Handle
80 * @return instance of yangModelCmHandle
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();
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());
97 * Create a yangModelCmHandle.
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
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;
124 * Resolve a dmi service name.
126 * @param requiredService indicates what typo of service is required
127 * @return dmi service name
129 public String resolveDmiServiceName(final RequiredDmiService requiredService) {
130 if (isNullEmptyOrBlank(dmiServiceName)) {
131 if (RequiredDmiService.DATA.equals(requiredService)) {
132 return dmiDataServiceName;
134 return dmiModelServiceName;
136 return dmiServiceName;
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()));
144 return yangModelCmHandleProperties;
147 private static boolean isNullEmptyOrBlank(final String serviceName) {
148 return Strings.isNullOrEmpty(serviceName) || serviceName.isBlank();
153 public static class Property {
156 private final String name;
159 private final String value;