2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2022 Nordix Foundation
4 * Modifications Copyright (C) 2022 Bell Canada
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.api.impl.operations;
24 import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.MODEL;
26 import com.google.gson.JsonArray;
27 import com.google.gson.JsonObject;
28 import java.util.ArrayList;
29 import java.util.Collection;
30 import java.util.HashMap;
31 import java.util.List;
33 import org.onap.cps.ncmp.api.impl.client.DmiRestClient;
34 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration;
35 import org.onap.cps.ncmp.api.impl.utils.DmiServiceUrlBuilder;
36 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
37 import org.onap.cps.ncmp.api.models.YangResource;
38 import org.onap.cps.spi.model.ModuleReference;
39 import org.onap.cps.utils.JsonObjectMapper;
40 import org.springframework.http.ResponseEntity;
41 import org.springframework.stereotype.Component;
44 * Operations class for DMI Model.
47 public class DmiModelOperations extends DmiOperations {
50 * Constructor for {@code DmiOperations}. This method also manipulates url properties.
52 * @param dmiRestClient {@code DmiRestClient}
54 public DmiModelOperations(final YangModelCmHandleRetriever dmiPropertiesRetriever,
55 final JsonObjectMapper jsonObjectMapper,
56 final NcmpConfiguration.DmiProperties dmiProperties,
57 final DmiRestClient dmiRestClient, final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
58 super(dmiPropertiesRetriever, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
62 * Retrieves module references.
64 * @param yangModelCmHandle the yang model cm handle
65 * @return module references
67 public List<ModuleReference> getModuleReferences(final YangModelCmHandle yangModelCmHandle) {
68 final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
70 dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
71 final ResponseEntity<Object> dmiFetchModulesResponseEntity = getResourceFromDmiWithJsonData(
72 yangModelCmHandle.resolveDmiServiceName(MODEL),
73 jsonObjectMapper.asJsonString(dmiRequestBody), yangModelCmHandle.getId(), "modules");
74 return toModuleReferences((Map) dmiFetchModulesResponseEntity.getBody());
78 * Retrieve yang resources from dmi for any modules that CPS-NCMP hasn't cached before.
80 * @param yangModelCmHandle the yangModelCmHandle
81 * @param newModuleReferences the unknown module references
82 * @return yang resources as map of module name to yang(re)source
84 public Map<String, String> getNewYangResourcesFromDmi(final YangModelCmHandle yangModelCmHandle,
85 final Collection<ModuleReference> newModuleReferences) {
86 final String jsonWithDataAndDmiProperties = getRequestBodyToFetchYangResources(
87 newModuleReferences, yangModelCmHandle.getDmiProperties());
88 final ResponseEntity<Object> responseEntity = getResourceFromDmiWithJsonData(
89 yangModelCmHandle.resolveDmiServiceName(MODEL),
90 jsonWithDataAndDmiProperties,
91 yangModelCmHandle.getId(),
93 return asModuleNameToYangResourceMap(responseEntity);
97 * Get resources from DMI for modules.
99 * @param dmiServiceName dmi service name
100 * @param jsonData module names and revisions as JSON
101 * @param cmHandle cmHandle
102 * @param resourceName name of the resource(s)
103 * @return {@code ResponseEntity} response entity
105 private ResponseEntity<Object> getResourceFromDmiWithJsonData(final String dmiServiceName,
106 final String jsonData,
107 final String cmHandle,
108 final String resourceName) {
109 final String dmiResourceDataUrl = getDmiResourceUrl(dmiServiceName, cmHandle, resourceName);
110 return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonData);
113 private static String getRequestBodyToFetchYangResources(final Collection<ModuleReference> newModuleReferences,
114 final List<YangModelCmHandle.Property> dmiProperties) {
115 final JsonArray moduleReferencesAsJson = getModuleReferencesAsJson(newModuleReferences);
116 final JsonObject data = new JsonObject();
117 data.add("modules", moduleReferencesAsJson);
118 final JsonObject jsonRequestObject = new JsonObject();
119 jsonRequestObject.add("data", data);
120 jsonRequestObject.add("cmHandleProperties", toJsonObject(dmiProperties));
121 return jsonRequestObject.toString();
124 private static JsonArray getModuleReferencesAsJson(final Collection<ModuleReference> unknownModuleReferences) {
125 final JsonArray moduleReferences = new JsonArray();
127 for (final ModuleReference moduleReference : unknownModuleReferences) {
128 final JsonObject moduleReferenceAsJson = new JsonObject();
129 moduleReferenceAsJson.addProperty("name", moduleReference.getModuleName());
130 moduleReferenceAsJson.addProperty("revision", moduleReference.getRevision());
131 moduleReferences.add(moduleReferenceAsJson);
133 return moduleReferences;
136 private static JsonObject toJsonObject(final List<YangModelCmHandle.Property>
138 final JsonObject asJsonObject = new JsonObject();
139 for (final YangModelCmHandle.Property additionalProperty : dmiProperties) {
140 asJsonObject.addProperty(additionalProperty.getName(), additionalProperty.getValue());
145 private List<ModuleReference> toModuleReferences(final Map<String, Object> dmiFetchModulesResponseAsMap) {
146 final List<ModuleReference> moduleReferences = new ArrayList<>();
148 if (dmiFetchModulesResponseAsMap != null) {
149 final List<Object> moduleReferencesAsList = (List) dmiFetchModulesResponseAsMap.get("schemas");
150 if (moduleReferencesAsList != null) {
151 moduleReferencesAsList.forEach(moduleReferenceAsMap -> {
152 final ModuleReference moduleReference =
153 jsonObjectMapper.convertToValueType(moduleReferenceAsMap, ModuleReference.class);
154 moduleReferences.add(moduleReference);
158 return moduleReferences;
161 private Map<String, String> asModuleNameToYangResourceMap(final ResponseEntity<Object> responseEntity) {
162 final Map<String, String> yangResourcesModuleNameToContentMap = new HashMap<>();
163 final List<Map<String, String>> yangResourcesAsList = (List) responseEntity.getBody();
165 if (yangResourcesAsList != null) {
166 yangResourcesAsList.forEach(yangResourceAsMap -> {
167 final YangResource yangResource =
168 jsonObjectMapper.convertToValueType(yangResourceAsMap, YangResource.class);
169 yangResourcesModuleNameToContentMap.put(yangResource.getModuleName(),
170 yangResource.getYangSource());
173 return yangResourcesModuleNameToContentMap;