2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2023 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.inventory.InventoryPersistence;
38 import org.onap.cps.ncmp.api.models.YangResource;
39 import org.onap.cps.spi.model.ModuleReference;
40 import org.onap.cps.utils.JsonObjectMapper;
41 import org.springframework.http.ResponseEntity;
42 import org.springframework.stereotype.Component;
45 * Operations class for DMI Model.
48 public class DmiModelOperations extends DmiOperations {
51 * Constructor for {@code DmiOperations}. This method also manipulates url properties.
53 * @param dmiRestClient {@code DmiRestClient}
55 public DmiModelOperations(final InventoryPersistence inventoryPersistence,
56 final JsonObjectMapper jsonObjectMapper,
57 final NcmpConfiguration.DmiProperties dmiProperties,
58 final DmiRestClient dmiRestClient, final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
59 super(inventoryPersistence, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
63 * Retrieves module references.
65 * @param yangModelCmHandle the yang model cm handle
66 * @return module references
68 public List<ModuleReference> getModuleReferences(final YangModelCmHandle yangModelCmHandle) {
69 final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
71 dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
72 final ResponseEntity<Object> dmiFetchModulesResponseEntity = getResourceFromDmiWithJsonData(
73 yangModelCmHandle.resolveDmiServiceName(MODEL),
74 jsonObjectMapper.asJsonString(dmiRequestBody), yangModelCmHandle.getId(), "modules");
75 return toModuleReferences((Map) dmiFetchModulesResponseEntity.getBody());
79 * Retrieve yang resources from dmi for any modules that CPS-NCMP hasn't cached before.
81 * @param yangModelCmHandle the yangModelCmHandle
82 * @param newModuleReferences the unknown module references
83 * @return yang resources as map of module name to yang(re)source
85 public Map<String, String> getNewYangResourcesFromDmi(final YangModelCmHandle yangModelCmHandle,
86 final Collection<ModuleReference> newModuleReferences) {
87 final String jsonWithDataAndDmiProperties = getRequestBodyToFetchYangResources(
88 newModuleReferences, yangModelCmHandle.getDmiProperties());
89 final ResponseEntity<Object> responseEntity = getResourceFromDmiWithJsonData(
90 yangModelCmHandle.resolveDmiServiceName(MODEL),
91 jsonWithDataAndDmiProperties,
92 yangModelCmHandle.getId(),
94 return asModuleNameToYangResourceMap(responseEntity);
98 * Get resources from DMI for modules.
100 * @param dmiServiceName dmi service name
101 * @param jsonRequestBody module names and revisions as JSON
102 * @param cmHandle cmHandle
103 * @param resourceName name of the resource(s)
104 * @return {@code ResponseEntity} response entity
106 private ResponseEntity<Object> getResourceFromDmiWithJsonData(final String dmiServiceName,
107 final String jsonRequestBody,
108 final String cmHandle,
109 final String resourceName) {
110 final String dmiResourceDataUrl = getDmiResourceUrl(dmiServiceName, cmHandle, resourceName);
111 return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody,
115 private static String getRequestBodyToFetchYangResources(final Collection<ModuleReference> newModuleReferences,
116 final List<YangModelCmHandle.Property> dmiProperties) {
117 final JsonArray moduleReferencesAsJson = getModuleReferencesAsJson(newModuleReferences);
118 final JsonObject data = new JsonObject();
119 data.add("modules", moduleReferencesAsJson);
120 final JsonObject jsonRequestObject = new JsonObject();
121 jsonRequestObject.add("data", data);
122 jsonRequestObject.add("cmHandleProperties", toJsonObject(dmiProperties));
123 return jsonRequestObject.toString();
126 private static JsonArray getModuleReferencesAsJson(final Collection<ModuleReference> unknownModuleReferences) {
127 final JsonArray moduleReferences = new JsonArray();
129 for (final ModuleReference moduleReference : unknownModuleReferences) {
130 final JsonObject moduleReferenceAsJson = new JsonObject();
131 moduleReferenceAsJson.addProperty("name", moduleReference.getModuleName());
132 moduleReferenceAsJson.addProperty("revision", moduleReference.getRevision());
133 moduleReferences.add(moduleReferenceAsJson);
135 return moduleReferences;
138 private static JsonObject toJsonObject(final List<YangModelCmHandle.Property>
140 final JsonObject asJsonObject = new JsonObject();
141 for (final YangModelCmHandle.Property additionalProperty : dmiProperties) {
142 asJsonObject.addProperty(additionalProperty.getName(), additionalProperty.getValue());
147 private List<ModuleReference> toModuleReferences(final Map<String, Object> dmiFetchModulesResponseAsMap) {
148 final List<ModuleReference> moduleReferences = new ArrayList<>();
150 if (dmiFetchModulesResponseAsMap != null) {
151 final List<Object> moduleReferencesAsList = (List) dmiFetchModulesResponseAsMap.get("schemas");
152 if (moduleReferencesAsList != null) {
153 moduleReferencesAsList.forEach(moduleReferenceAsMap -> {
154 final ModuleReference moduleReference =
155 jsonObjectMapper.convertToValueType(moduleReferenceAsMap, ModuleReference.class);
156 moduleReferences.add(moduleReference);
160 return moduleReferences;
163 private Map<String, String> asModuleNameToYangResourceMap(final ResponseEntity<Object> responseEntity) {
164 final Map<String, String> yangResourcesModuleNameToContentMap = new HashMap<>();
165 final List<Map<String, String>> yangResourcesAsList = (List) responseEntity.getBody();
167 if (yangResourcesAsList != null) {
168 yangResourcesAsList.forEach(yangResourceAsMap -> {
169 final YangResource yangResource =
170 jsonObjectMapper.convertToValueType(yangResourceAsMap, YangResource.class);
171 yangResourcesModuleNameToContentMap.put(yangResource.getModuleName(),
172 yangResource.getYangSource());
175 return yangResourcesModuleNameToContentMap;