2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 highstreet technologies GmbH
4 * Modifications Copyright (C) 2021 Nordix Foundation
5 * Modifications Copyright (C) 2021 Pantheon.tech
6 * Modifications Copyright (C) 2021 Bell Canada
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.cps.ncmp.api.impl;
26 import com.fasterxml.jackson.core.JsonProcessingException;
27 import com.fasterxml.jackson.databind.ObjectMapper;
28 import com.google.gson.Gson;
29 import com.google.gson.JsonArray;
30 import com.google.gson.JsonElement;
31 import com.google.gson.JsonObject;
32 import java.time.OffsetDateTime;
33 import java.util.ArrayList;
34 import java.util.Collection;
35 import java.util.Collections;
36 import java.util.HashMap;
37 import java.util.LinkedHashMap;
38 import java.util.List;
40 import javax.validation.constraints.NotNull;
41 import lombok.extern.slf4j.Slf4j;
42 import org.onap.cps.api.CpsAdminService;
43 import org.onap.cps.api.CpsDataService;
44 import org.onap.cps.api.CpsModuleService;
45 import org.onap.cps.api.CpsQueryService;
46 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
47 import org.onap.cps.ncmp.api.impl.exception.NcmpException;
48 import org.onap.cps.ncmp.api.impl.operation.DmiOperations;
49 import org.onap.cps.ncmp.api.models.CmHandle;
50 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
51 import org.onap.cps.ncmp.api.models.GenericRequestBody;
52 import org.onap.cps.ncmp.api.models.PersistenceCmHandle;
53 import org.onap.cps.ncmp.api.models.PersistenceCmHandle.AdditionalProperty;
54 import org.onap.cps.ncmp.api.models.PersistenceCmHandlesList;
55 import org.onap.cps.ncmp.api.models.YangResource;
56 import org.onap.cps.spi.FetchDescendantsOption;
57 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
58 import org.onap.cps.spi.exceptions.DataValidationException;
59 import org.onap.cps.spi.model.DataNode;
60 import org.onap.cps.spi.model.ModuleReference;
61 import org.springframework.http.HttpStatus;
62 import org.springframework.http.ResponseEntity;
63 import org.springframework.stereotype.Service;
64 import org.springframework.util.StringUtils;
68 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
70 private static final String NF_PROXY_DATASPACE_NAME = "NFP-Operational";
72 private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
74 private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
76 private static final OffsetDateTime NO_TIMESTAMP = null;
78 private static final String NCMP_DMI_SERVICE_NAME = "dmi-service-name";
80 private static final String REVISION = "revision";
82 private CpsDataService cpsDataService;
84 private ObjectMapper objectMapper;
86 private CpsQueryService cpsQueryService;
88 private DmiOperations dmiOperations;
90 private CpsModuleService cpsModuleService;
92 private CpsAdminService cpsAdminService;
95 * Constructor Injection for Dependencies.
96 * @param dmiOperations DMI operation
97 * @param cpsDataService Data Service Interface
98 * @param cpsQueryService Query Service Interface
99 * @param objectMapper Object Mapper
101 public NetworkCmProxyDataServiceImpl(final DmiOperations dmiOperations,
102 final CpsModuleService cpsModuleService,
103 final CpsDataService cpsDataService,
104 final CpsQueryService cpsQueryService,
105 final CpsAdminService cpsAdminService,
106 final ObjectMapper objectMapper) {
107 this.dmiOperations = dmiOperations;
108 this.cpsModuleService = cpsModuleService;
109 this.cpsDataService = cpsDataService;
110 this.cpsQueryService = cpsQueryService;
111 this.cpsAdminService = cpsAdminService;
112 this.objectMapper = objectMapper;
116 public DataNode getDataNode(final String cmHandle, final String xpath,
117 final FetchDescendantsOption fetchDescendantsOption) {
118 return cpsDataService.getDataNode(NF_PROXY_DATASPACE_NAME, cmHandle, xpath, fetchDescendantsOption);
122 public Collection<DataNode> queryDataNodes(final String cmHandle, final String cpsPath,
123 final FetchDescendantsOption fetchDescendantsOption) {
124 return cpsQueryService.queryDataNodes(NF_PROXY_DATASPACE_NAME, cmHandle, cpsPath, fetchDescendantsOption);
128 public void createDataNode(final String cmHandle, final String parentNodeXpath, final String jsonData) {
129 if (!StringUtils.hasText(parentNodeXpath) || "/".equals(parentNodeXpath)) {
130 cpsDataService.saveData(NF_PROXY_DATASPACE_NAME, cmHandle, jsonData, NO_TIMESTAMP);
132 cpsDataService.saveData(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData, NO_TIMESTAMP);
137 public void addListNodeElements(final String cmHandle, final String parentNodeXpath, final String jsonData) {
138 cpsDataService.saveListNodeData(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData, NO_TIMESTAMP);
142 public void updateNodeLeaves(final String cmHandle, final String parentNodeXpath, final String jsonData) {
143 cpsDataService.updateNodeLeaves(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData, NO_TIMESTAMP);
147 public void replaceNodeTree(final String cmHandle, final String parentNodeXpath, final String jsonData) {
148 cpsDataService.replaceNodeTree(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData, NO_TIMESTAMP);
152 public void updateDmiRegistrationAndSyncModule(final DmiPluginRegistration dmiPluginRegistration) {
154 if (dmiPluginRegistration.getCreatedCmHandles() != null) {
155 parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(dmiPluginRegistration);
157 if (dmiPluginRegistration.getUpdatedCmHandles() != null) {
158 parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration);
160 if (dmiPluginRegistration.getRemovedCmHandles() != null) {
161 parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration);
163 } catch (final JsonProcessingException e) {
164 handleJsonProcessingException(dmiPluginRegistration, e);
169 public Object getResourceDataOperationalForCmHandle(final @NotNull String cmHandle,
170 final @NotNull String resourceIdentifier,
171 final String acceptParam,
172 final String fieldsQueryParam,
173 final Integer depthQueryParam) {
175 final DataNode cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
176 final String dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get(NCMP_DMI_SERVICE_NAME));
177 final String dmiRequestBody = getGenericRequestBody(cmHandleDataNode);
178 final ResponseEntity<Object> response = dmiOperations.getResourceDataOperationalFromDmi(dmiServiceName,
185 return handleResponse(response);
189 public Object getResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle,
190 final @NotNull String resourceIdentifier,
191 final String acceptParam,
193 final Integer depth) {
194 final DataNode cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
195 final String dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get(NCMP_DMI_SERVICE_NAME));
196 final String dmiRequestBody = getGenericRequestBody(cmHandleDataNode);
197 final ResponseEntity<Object> response = dmiOperations.getResourceDataPassThroughRunningFromDmi(dmiServiceName,
204 return handleResponse(response);
208 public void createResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle,
209 final @NotNull String resourceIdentifier,
210 final @NotNull String requestBody,
211 final String contentType) {
212 final DataNode cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
213 final String dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get(NCMP_DMI_SERVICE_NAME));
214 final Collection<DataNode> cmHandlePropertiesAsDataNodes = cmHandleDataNode.getChildDataNodes();
215 final Map<String, String> cmHandlePropertiesAsMap = getCmHandlePropertiesAsMap(cmHandlePropertiesAsDataNodes);
216 final GenericRequestBody dmiRequestBodyObject = GenericRequestBody.builder()
217 .operation(GenericRequestBody.OperationEnum.CREATE)
218 .dataType(contentType)
220 .cmHandleProperties(cmHandlePropertiesAsMap)
222 final String dmiRequestBody = prepareOperationBody(dmiRequestBodyObject);
223 final ResponseEntity<String> responseEntity = dmiOperations
224 .createResourceDataPassThroughRunningFromDmi(dmiServiceName,
228 handleResponseForPost(responseEntity);
232 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandle) {
233 return cpsModuleService.getYangResourcesModuleReferences(NF_PROXY_DATASPACE_NAME, cmHandle);
236 private DataNode fetchDataNodeFromDmiRegistryForCmHandle(final String cmHandle) {
237 final String xpathForDmiRegistryToFetchCmHandle = "/dmi-registry/cm-handles[@id='" + cmHandle + "']";
238 return cpsDataService.getDataNode(NCMP_DATASPACE_NAME,
239 NCMP_DMI_REGISTRY_ANCHOR,
240 xpathForDmiRegistryToFetchCmHandle,
241 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
244 private String prepareOperationBody(final GenericRequestBody requestBodyObject) {
246 return objectMapper.writeValueAsString(requestBodyObject);
247 } catch (final JsonProcessingException e) {
248 log.error("Parsing error occurred while converting Object to JSON.");
249 throw new NcmpException("Parsing error occurred while converting given object to JSON.",
254 private static Map<String, String> getCmHandlePropertiesAsMap(
255 final Collection<DataNode> cmHandlePropertiesAsDataNode) {
256 if (cmHandlePropertiesAsDataNode.isEmpty()) {
257 return Collections.emptyMap();
259 final Map<String, String> cmHandlePropertiesAsMap = new LinkedHashMap<>();
260 for (final DataNode dataNode: cmHandlePropertiesAsDataNode) {
261 cmHandlePropertiesAsMap.put(String.valueOf(dataNode.getLeaves().get("name")),
262 String.valueOf(dataNode.getLeaves().get("value")));
264 return cmHandlePropertiesAsMap;
267 private static Map<String, String> getCmHandlePropertiesAsMap(
268 final List<AdditionalProperty> cmHandlePropertiesAsList) {
269 if (cmHandlePropertiesAsList == null || cmHandlePropertiesAsList.isEmpty()) {
270 return Collections.emptyMap();
272 final Map<String, String> cmHandlePropertiesAsMap = new LinkedHashMap<>();
273 for (final AdditionalProperty additionalProperty: cmHandlePropertiesAsList) {
274 cmHandlePropertiesAsMap.put(additionalProperty.getName(),
275 additionalProperty.getValue());
277 return cmHandlePropertiesAsMap;
280 private static Object handleResponse(final @NotNull ResponseEntity<Object> responseEntity) {
281 if (responseEntity.getStatusCode() == HttpStatus.OK) {
282 return responseEntity.getBody();
284 throw new NcmpException("Not able to get resource data.",
285 "DMI status code: " + responseEntity.getStatusCodeValue()
286 + ", DMI response body: " + responseEntity.getBody());
290 private static void handleResponseForPost(final @NotNull ResponseEntity<String> responseEntity) {
291 if (responseEntity.getStatusCode() != HttpStatus.OK) {
292 throw new NcmpException("Not able to create resource data.",
293 "DMI status code: " + responseEntity.getStatusCodeValue()
294 + ", DMI response body: " + responseEntity.getBody());
298 private String getGenericRequestBody(final DataNode cmHandleDataNode) {
299 final Collection<DataNode> cmHandlePropertiesAsDataNodes = cmHandleDataNode.getChildDataNodes();
300 final Map<String, String> cmHandlePropertiesAsMap = getCmHandlePropertiesAsMap(cmHandlePropertiesAsDataNodes);
301 final GenericRequestBody requestBodyObject = GenericRequestBody.builder()
302 .operation(GenericRequestBody.OperationEnum.READ)
303 .cmHandleProperties(cmHandlePropertiesAsMap)
305 return prepareOperationBody(requestBodyObject);
308 private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration)
309 throws JsonProcessingException {
310 final PersistenceCmHandlesList updatedPersistenceCmHandlesList = toPersistenceCmHandlesList(
311 dmiPluginRegistration.getDmiPlugin(),
312 dmiPluginRegistration.getUpdatedCmHandles());
313 final String cmHandlesAsJson = objectMapper.writeValueAsString(updatedPersistenceCmHandlesList);
314 cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
315 "/dmi-registry", cmHandlesAsJson, NO_TIMESTAMP);
318 private void parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(
319 final DmiPluginRegistration dmiPluginRegistration) throws JsonProcessingException {
320 final PersistenceCmHandlesList createdPersistenceCmHandlesList = toPersistenceCmHandlesList(
321 dmiPluginRegistration.getDmiPlugin(),
322 dmiPluginRegistration.getCreatedCmHandles());
323 registerAndSyncNewCmHandles(createdPersistenceCmHandlesList);
326 private static PersistenceCmHandlesList toPersistenceCmHandlesList(final String dmiPlugin,
327 final Collection<CmHandle> cmHandles) {
328 final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList();
329 for (final CmHandle cmHandle : cmHandles) {
330 final PersistenceCmHandle persistenceCmHandle = toPersistenceCmHandle(dmiPlugin, cmHandle);
331 persistenceCmHandlesList.add(persistenceCmHandle);
333 return persistenceCmHandlesList;
336 private static void handleJsonProcessingException(final DmiPluginRegistration dmiPluginRegistration,
337 final JsonProcessingException e) {
338 final String message = "Parsing error occurred while processing DMI Plugin Registration"
339 + dmiPluginRegistration;
341 throw new DataValidationException(message, e.getMessage(), e);
344 private void registerAndSyncNewCmHandles(final PersistenceCmHandlesList persistenceCmHandlesList)
345 throws JsonProcessingException {
346 final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
347 cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry",
348 cmHandleJsonData, NO_TIMESTAMP);
350 for (final PersistenceCmHandle persistenceCmHandle : persistenceCmHandlesList.getPersistenceCmHandles()) {
351 syncModulesAndCreateAnchor(persistenceCmHandle);
355 protected void syncModulesAndCreateAnchor(final PersistenceCmHandle persistenceCmHandle) {
356 fetchAndSyncModules(persistenceCmHandle);
357 createAnchor(persistenceCmHandle);
360 private static PersistenceCmHandle toPersistenceCmHandle(final String dmiPluginService,
361 final CmHandle cmHandle) {
362 final PersistenceCmHandle persistenceCmHandle = new PersistenceCmHandle();
363 persistenceCmHandle.setDmiServiceName(dmiPluginService);
364 persistenceCmHandle.setId(cmHandle.getCmHandleID());
365 if (cmHandle.getCmHandleProperties() == null) {
366 persistenceCmHandle.setAdditionalProperties(Collections.emptyMap());
368 persistenceCmHandle.setAdditionalProperties(cmHandle.getCmHandleProperties());
370 return persistenceCmHandle;
373 private void parseAndRemoveCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
374 for (final String cmHandle : dmiPluginRegistration.getRemovedCmHandles()) {
376 cpsDataService.deleteListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
377 "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
378 } catch (final DataNodeNotFoundException e) {
379 log.warn("Datanode {} not deleted message {}", cmHandle, e.getMessage());
384 private void fetchAndSyncModules(final PersistenceCmHandle persistenceCmHandle) {
385 final Map<String, String> cmHandlePropertiesAsMap = getCmHandlePropertiesAsMap(
386 persistenceCmHandle.getAdditionalProperties());
388 final List<ModuleReference> moduleReferencesFromCmHandle =
389 fetchModuleReferencesFromDmi(persistenceCmHandle, cmHandlePropertiesAsMap);
390 final List<ModuleReference> existingModuleReferences = new ArrayList<>();
391 final List<ModuleReference> unknownModuleReferences = new ArrayList<>();
392 prepareModuleSubsets(moduleReferencesFromCmHandle, existingModuleReferences, unknownModuleReferences);
394 final Map<String, String> newYangResourcesModuleNameToContentMap =
395 getNewYangResourcesFromDmi(persistenceCmHandle, unknownModuleReferences, cmHandlePropertiesAsMap);
397 cpsModuleService.createSchemaSetFromModules(NF_PROXY_DATASPACE_NAME, persistenceCmHandle.getId(),
398 newYangResourcesModuleNameToContentMap, existingModuleReferences);
401 private void prepareModuleSubsets(final List<ModuleReference> moduleReferencesFromCmHandle,
402 final List<ModuleReference> existingModuleReferences,
403 final List<ModuleReference> unknownModuleReferences) {
405 final Collection<ModuleReference> knownModuleReferencesInCps =
406 cpsModuleService.getYangResourceModuleReferences(NF_PROXY_DATASPACE_NAME);
408 for (final ModuleReference moduleReferenceFromDmiForCmHandle : moduleReferencesFromCmHandle) {
409 if (knownModuleReferencesInCps.contains(moduleReferenceFromDmiForCmHandle)) {
410 existingModuleReferences.add(moduleReferenceFromDmiForCmHandle);
412 unknownModuleReferences.add(moduleReferenceFromDmiForCmHandle);
417 private List<ModuleReference> fetchModuleReferencesFromDmi(final PersistenceCmHandle persistenceCmHandle,
418 final Map<String, String> cmHandlePropertiesAsMap) {
419 final GenericRequestBody genericRequestBody = GenericRequestBody.builder()
420 .cmHandleProperties(cmHandlePropertiesAsMap)
422 final String jsonBodyWithOnlyCmHandleProperties = prepareOperationBody(genericRequestBody);
423 final ResponseEntity<String> dmiFetchModulesResponseEntity =
424 dmiOperations.getResourceFromDmiWithJsonData(persistenceCmHandle.getDmiServiceName(),
425 jsonBodyWithOnlyCmHandleProperties, persistenceCmHandle.getId(), "modules");
426 return toModuleReferences(dmiFetchModulesResponseEntity);
429 private void createAnchor(final PersistenceCmHandle persistenceCmHandle) {
430 cpsAdminService.createAnchor(NF_PROXY_DATASPACE_NAME, persistenceCmHandle.getId(), persistenceCmHandle.getId());
433 private String getRequestBodyToFetchYangResourceFromDmi(final List<ModuleReference> unknownModuleReferences,
434 final Map<String, String> cmHandlePropertiesAsMap) {
435 final JsonArray moduleReferencesAsJson = getModuleReferencesAsJson(unknownModuleReferences);
436 final JsonObject data = new JsonObject();
437 data.add("modules", moduleReferencesAsJson);
438 final JsonObject jsonRequestObject = new JsonObject();
439 jsonRequestObject.add("data", data);
440 final Gson gson = new Gson();
441 jsonRequestObject.add("cmHandleProperties", gson.toJsonTree(cmHandlePropertiesAsMap));
442 return jsonRequestObject.toString();
445 private static JsonArray getModuleReferencesAsJson(final List<ModuleReference> unknownModuleReferences) {
446 final JsonArray moduleReferences = new JsonArray();
448 for (final ModuleReference moduleReference : unknownModuleReferences) {
449 final JsonObject moduleReferenceAsJson = new JsonObject();
450 moduleReferenceAsJson.addProperty("name", moduleReference.getModuleName());
451 moduleReferenceAsJson.addProperty(REVISION, moduleReference.getRevision());
452 moduleReferences.add(moduleReferenceAsJson);
454 return moduleReferences;
457 private Map<String, String> getNewYangResourcesFromDmi(final PersistenceCmHandle persistenceCmHandle,
458 final List<ModuleReference> unknownModuleReferences,
459 final Map<String, String> cmHandlePropertiesAsMap) {
460 final String jsonDataWithDataAndCmHandleProperties = getRequestBodyToFetchYangResourceFromDmi(
461 unknownModuleReferences, cmHandlePropertiesAsMap);
463 final ResponseEntity<String> moduleResourcesAsJsonString = dmiOperations.getResourceFromDmiWithJsonData(
464 persistenceCmHandle.getDmiServiceName(),
465 jsonDataWithDataAndCmHandleProperties,
466 persistenceCmHandle.getId(),
469 final JsonArray moduleResources = new Gson().fromJson(moduleResourcesAsJsonString.getBody(),
471 final Map<String, String> newYangResourcesModuleNameToContentMap = new HashMap<>();
473 for (final JsonElement moduleResource : moduleResources) {
474 final YangResource yangResource = toYangResource((JsonObject) moduleResource);
475 newYangResourcesModuleNameToContentMap.put(yangResource.getModuleName(), yangResource.getYangSource());
477 return newYangResourcesModuleNameToContentMap;
480 private static YangResource toYangResource(final JsonObject yangResourceAsJson) {
481 final YangResource yangResource = new YangResource();
482 yangResource.setModuleName(yangResourceAsJson.get("moduleName").getAsString());
483 yangResource.setRevision(yangResourceAsJson.get(REVISION).getAsString());
484 final String yangSourceJson = yangResourceAsJson.get("yangSource").getAsString();
486 String yangSource = JsonUtils.removeWrappingTokens(yangSourceJson);
487 yangSource = JsonUtils.removeRedundantEscapeCharacters(yangSource);
488 yangResource.setYangSource(yangSource);
493 private static List<ModuleReference> toModuleReferences(
494 final ResponseEntity<String> dmiFetchModulesResponseEntity) {
495 final List<ModuleReference> moduleReferences = new ArrayList<>();
496 final JsonObject bodyAsJsonObject = new Gson().fromJson(dmiFetchModulesResponseEntity.getBody(),
498 final JsonArray moduleReferencesAsJson = bodyAsJsonObject.getAsJsonArray("schemas");
499 for (final JsonElement moduleReferenceAsJson : moduleReferencesAsJson) {
500 final ModuleReference moduleReference = toModuleReference((JsonObject) moduleReferenceAsJson);
501 moduleReferences.add(moduleReference);
503 return moduleReferences;
506 private static ModuleReference toModuleReference(final JsonObject moduleReferenceAsJson) {
507 final ModuleReference moduleReference = new ModuleReference();
508 moduleReference.setModuleName(moduleReferenceAsJson.get("moduleName").getAsString());
509 moduleReference.setRevision(moduleReferenceAsJson.get(REVISION).getAsString());
510 return moduleReference;