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.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;
43 * Cm Handle which follows the Yang resource dmi registry model when persisting data to DMI or the DB.
49 @JsonInclude(Include.NON_NULL)
50 @EqualsAndHashCode(onlyExplicitlyIncluded = true)
51 public class YangModelCmHandle {
53 @EqualsAndHashCode.Include
56 @JsonProperty("dmi-service-name")
57 private String dmiServiceName;
59 @JsonProperty("dmi-data-service-name")
60 private String dmiDataServiceName;
62 @JsonProperty("state")
63 private CompositeState compositeState;
65 @JsonProperty("dmi-model-service-name")
66 private String dmiModelServiceName;
68 @JsonProperty("module-set-tag")
69 private String moduleSetTag;
71 @JsonProperty("additional-properties")
72 private List<Property> dmiProperties;
74 @JsonProperty("public-properties")
75 private List<Property> publicProperties;
78 * Creates a deep copy of Yang Model Cm Handle.
80 * @param original Yang Model Cm Handle
81 * @return instance of yangModelCmHandle
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();
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());
98 * Create a yangModelCmHandle.
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
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;
125 * Resolve a dmi service name.
127 * @param requiredService indicates what typo of service is required
128 * @return dmi service name
130 public String resolveDmiServiceName(final RequiredDmiService requiredService) {
131 if (isNullEmptyOrBlank(dmiServiceName)) {
132 if (RequiredDmiService.DATA.equals(requiredService)) {
133 return dmiDataServiceName;
135 return dmiModelServiceName;
137 return dmiServiceName;
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()));
145 return yangModelCmHandleProperties;
148 private static boolean isNullEmptyOrBlank(final String serviceName) {
149 return Strings.isNullOrEmpty(serviceName) || serviceName.isBlank();
154 public static class Property {
157 private final String name;
160 private final String value;