2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2022 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;
34 import lombok.NoArgsConstructor;
36 import org.onap.cps.ncmp.api.impl.operations.RequiredDmiService;
37 import org.onap.cps.ncmp.api.inventory.CompositeState;
38 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
39 import org.onap.cps.utils.CpsValidator;
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 public class YangModelCmHandle {
53 @JsonProperty("dmi-service-name")
54 private String dmiServiceName;
56 @JsonProperty("dmi-data-service-name")
57 private String dmiDataServiceName;
59 @JsonProperty("state")
60 private CompositeState compositeState;
62 @JsonProperty("dmi-model-service-name")
63 private String dmiModelServiceName;
65 @JsonProperty("additional-properties")
66 private List<Property> dmiProperties;
68 @JsonProperty("public-properties")
69 private List<Property> publicProperties;
72 * Creates a deep copy of Yang Model Cm Handle.
74 * @param original Yang Model Cm Handle
75 * @return instance of yangModelCmHandle
77 public static YangModelCmHandle deepCopyOf(final YangModelCmHandle original) {
78 final YangModelCmHandle copy = new YangModelCmHandle();
79 copy.id = original.getId();
80 copy.dmiServiceName = original.getDmiServiceName();
81 copy.dmiDataServiceName = original.getDmiDataServiceName();
82 copy.dmiModelServiceName = original.getDmiModelServiceName();
84 original.getCompositeState() == null ? null : new CompositeState(original.getCompositeState());
85 copy.dmiProperties = original.getDmiProperties() == null ? null : new ArrayList<>(original.getDmiProperties());
86 copy.publicProperties =
87 original.getPublicProperties() == null ? null : new ArrayList<>(original.getPublicProperties());
92 * Create a yangModelCmHandle.
94 * @param dmiServiceName dmi service name
95 * @param dmiDataServiceName dmi data service name
96 * @param dmiModelServiceName dmi model service name
97 * @param ncmpServiceCmHandle the cm handle
98 * @return instance of yangModelCmHandle
100 public static YangModelCmHandle toYangModelCmHandle(final String dmiServiceName,
101 final String dmiDataServiceName,
102 final String dmiModelServiceName,
103 final NcmpServiceCmHandle ncmpServiceCmHandle) {
104 CpsValidator.validateNameCharacters(ncmpServiceCmHandle.getCmHandleId());
105 final YangModelCmHandle yangModelCmHandle = new YangModelCmHandle();
106 yangModelCmHandle.setId(ncmpServiceCmHandle.getCmHandleId());
107 yangModelCmHandle.setDmiServiceName(dmiServiceName);
108 yangModelCmHandle.setDmiDataServiceName(dmiDataServiceName);
109 yangModelCmHandle.setDmiModelServiceName(dmiModelServiceName);
110 yangModelCmHandle.setDmiProperties(asYangModelCmHandleProperties(ncmpServiceCmHandle.getDmiProperties()));
111 yangModelCmHandle.setPublicProperties(asYangModelCmHandleProperties(
112 ncmpServiceCmHandle.getPublicProperties()));
113 yangModelCmHandle.setCompositeState(ncmpServiceCmHandle.getCompositeState());
114 return yangModelCmHandle;
118 * Resolve a dmi service name.
120 * @param requiredService indicates what typo of service is required
121 * @return dmi service name
123 public String resolveDmiServiceName(final RequiredDmiService requiredService) {
124 if (isNullEmptyOrBlank(dmiServiceName)) {
125 if (RequiredDmiService.DATA.equals(requiredService)) {
126 return dmiDataServiceName;
128 return dmiModelServiceName;
130 return dmiServiceName;
133 private static List<Property> asYangModelCmHandleProperties(final Map<String, String> propertiesAsMap) {
134 final List<Property> yangModelCmHandleProperties = new ArrayList<>(propertiesAsMap.size());
135 for (final Map.Entry<String, String> entry : propertiesAsMap.entrySet()) {
136 yangModelCmHandleProperties.add(new YangModelCmHandle.Property(entry.getKey(), entry.getValue()));
138 return yangModelCmHandleProperties;
141 private static boolean isNullEmptyOrBlank(final String serviceName) {
142 return Strings.isNullOrEmpty(serviceName) || serviceName.isBlank();
147 public static class Property {
150 private final String name;
153 private final String value;