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;
33 import lombok.EqualsAndHashCode;
35 import lombok.NoArgsConstructor;
37 import org.onap.cps.ncmp.api.impl.operations.RequiredDmiService;
38 import org.onap.cps.ncmp.api.inventory.CompositeState;
39 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
40 import org.onap.cps.utils.CpsValidator;
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("additional-properties")
69 private List<Property> dmiProperties;
71 @JsonProperty("public-properties")
72 private List<Property> publicProperties;
75 * Creates a deep copy of Yang Model Cm Handle.
77 * @param original Yang Model Cm Handle
78 * @return instance of yangModelCmHandle
80 public static YangModelCmHandle deepCopyOf(final YangModelCmHandle original) {
81 final YangModelCmHandle copy = new YangModelCmHandle();
82 copy.id = original.getId();
83 copy.dmiServiceName = original.getDmiServiceName();
84 copy.dmiDataServiceName = original.getDmiDataServiceName();
85 copy.dmiModelServiceName = original.getDmiModelServiceName();
87 original.getCompositeState() == null ? null : new CompositeState(original.getCompositeState());
88 copy.dmiProperties = original.getDmiProperties() == null ? null : new ArrayList<>(original.getDmiProperties());
89 copy.publicProperties =
90 original.getPublicProperties() == null ? null : new ArrayList<>(original.getPublicProperties());
95 * Create a yangModelCmHandle.
97 * @param dmiServiceName dmi service name
98 * @param dmiDataServiceName dmi data service name
99 * @param dmiModelServiceName dmi model service name
100 * @param ncmpServiceCmHandle the cm handle
101 * @return instance of yangModelCmHandle
103 public static YangModelCmHandle toYangModelCmHandle(final String dmiServiceName,
104 final String dmiDataServiceName,
105 final String dmiModelServiceName,
106 final NcmpServiceCmHandle ncmpServiceCmHandle) {
107 CpsValidator.validateNameCharacters(ncmpServiceCmHandle.getCmHandleId());
108 final YangModelCmHandle yangModelCmHandle = new YangModelCmHandle();
109 yangModelCmHandle.setId(ncmpServiceCmHandle.getCmHandleId());
110 yangModelCmHandle.setDmiServiceName(dmiServiceName);
111 yangModelCmHandle.setDmiDataServiceName(dmiDataServiceName);
112 yangModelCmHandle.setDmiModelServiceName(dmiModelServiceName);
113 yangModelCmHandle.setDmiProperties(asYangModelCmHandleProperties(ncmpServiceCmHandle.getDmiProperties()));
114 yangModelCmHandle.setPublicProperties(asYangModelCmHandleProperties(
115 ncmpServiceCmHandle.getPublicProperties()));
116 yangModelCmHandle.setCompositeState(ncmpServiceCmHandle.getCompositeState());
117 return yangModelCmHandle;
121 * Resolve a dmi service name.
123 * @param requiredService indicates what typo of service is required
124 * @return dmi service name
126 public String resolveDmiServiceName(final RequiredDmiService requiredService) {
127 if (isNullEmptyOrBlank(dmiServiceName)) {
128 if (RequiredDmiService.DATA.equals(requiredService)) {
129 return dmiDataServiceName;
131 return dmiModelServiceName;
133 return dmiServiceName;
136 private static List<Property> asYangModelCmHandleProperties(final Map<String, String> propertiesAsMap) {
137 final List<Property> yangModelCmHandleProperties = new ArrayList<>(propertiesAsMap.size());
138 for (final Map.Entry<String, String> entry : propertiesAsMap.entrySet()) {
139 yangModelCmHandleProperties.add(new YangModelCmHandle.Property(entry.getKey(), entry.getValue()));
141 return yangModelCmHandleProperties;
144 private static boolean isNullEmptyOrBlank(final String serviceName) {
145 return Strings.isNullOrEmpty(serviceName) || serviceName.isBlank();
150 public static class Property {
153 private final String name;
156 private final String value;