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.models.NcmpServiceCmHandle;
40 * Cm Handle which follows the Yang resource dmi registry model when persisting data to DMI or the DB.
46 @JsonInclude(Include.NON_NULL)
47 public class YangModelCmHandle {
51 @JsonProperty("dmi-service-name")
52 private String dmiServiceName;
54 @JsonProperty("dmi-data-service-name")
55 private String dmiDataServiceName;
57 @JsonProperty("dmi-model-service-name")
58 private String dmiModelServiceName;
60 @JsonProperty("additional-properties")
61 private List<Property> dmiProperties;
63 @JsonProperty("public-properties")
64 private List<Property> publicProperties;
67 * Create a yangModelCmHandle.
68 * @param dmiServiceName dmi service name
69 * @param dmiDataServiceName dmi data service name
70 * @param dmiModelServiceName dmi model service name
71 * @param ncmpServiceCmHandle the cm handle
72 * @return instance of yangModelCmHandle
74 public static YangModelCmHandle toYangModelCmHandle(final String dmiServiceName,
75 final String dmiDataServiceName,
76 final String dmiModelServiceName,
77 final NcmpServiceCmHandle ncmpServiceCmHandle) {
78 final YangModelCmHandle yangModelCmHandle = new YangModelCmHandle();
79 yangModelCmHandle.setId(ncmpServiceCmHandle.getCmHandleID());
80 yangModelCmHandle.setDmiServiceName(dmiServiceName);
81 yangModelCmHandle.setDmiDataServiceName(dmiDataServiceName);
82 yangModelCmHandle.setDmiModelServiceName(dmiModelServiceName);
83 yangModelCmHandle.setDmiProperties(asYangModelCmHandleProperties(ncmpServiceCmHandle.getDmiProperties()));
84 yangModelCmHandle.setPublicProperties(asYangModelCmHandleProperties(
85 ncmpServiceCmHandle.getPublicProperties()));
86 return yangModelCmHandle;
90 * Resolve a dmi service name.
91 * @param requiredService indicates what typo of service is required
92 * @return dmi service name
94 public String resolveDmiServiceName(final RequiredDmiService requiredService) {
95 if (isNullEmptyOrBlank(dmiServiceName)) {
96 if (RequiredDmiService.DATA.equals(requiredService)) {
97 return dmiDataServiceName;
99 return dmiModelServiceName;
101 return dmiServiceName;
104 private static List<Property> asYangModelCmHandleProperties(final Map<String, String> propertiesAsMap) {
105 final List<Property> yangModelCmHandleProperties = new ArrayList<>(propertiesAsMap.size());
106 for (final Map.Entry<String, String> entry : propertiesAsMap.entrySet()) {
107 yangModelCmHandleProperties.add(new YangModelCmHandle.Property(entry.getKey(), entry.getValue()));
109 return yangModelCmHandleProperties;
112 private static boolean isNullEmptyOrBlank(final String serviceName) {
113 return Strings.isNullOrEmpty(serviceName) || serviceName.isBlank();
118 public static class Property {
121 private final String name;
124 private final String value;