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.MediaType;
63 import org.springframework.http.ResponseEntity;
64 import org.springframework.stereotype.Service;
65 import org.springframework.util.StringUtils;
69 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
71 private static final String NF_PROXY_DATASPACE_NAME = "NFP-Operational";
73 private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
75 private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
77 private static final OffsetDateTime NO_TIMESTAMP = null;
79 private static final String NCMP_DMI_SERVICE_NAME = "dmi-service-name";
81 private static final String REVISION = "revision";
83 private CpsDataService cpsDataService;
85 private ObjectMapper objectMapper;
87 private CpsQueryService cpsQueryService;
89 private DmiOperations dmiOperations;
91 private CpsModuleService cpsModuleService;
93 private CpsAdminService cpsAdminService;
96 * Constructor Injection for Dependencies.
97 * @param dmiOperations DMI operation
98 * @param cpsDataService Data Service Interface
99 * @param cpsQueryService Query Service Interface
100 * @param objectMapper Object Mapper
102 public NetworkCmProxyDataServiceImpl(final DmiOperations dmiOperations,
103 final CpsModuleService cpsModuleService,
104 final CpsDataService cpsDataService,
105 final CpsQueryService cpsQueryService,
106 final CpsAdminService cpsAdminService,
107 final ObjectMapper objectMapper) {
108 this.dmiOperations = dmiOperations;
109 this.cpsModuleService = cpsModuleService;
110 this.cpsDataService = cpsDataService;
111 this.cpsQueryService = cpsQueryService;
112 this.cpsAdminService = cpsAdminService;
113 this.objectMapper = objectMapper;
117 public DataNode getDataNode(final String cmHandle, final String xpath,
118 final FetchDescendantsOption fetchDescendantsOption) {
119 return cpsDataService.getDataNode(NF_PROXY_DATASPACE_NAME, cmHandle, xpath, fetchDescendantsOption);
123 public Collection<DataNode> queryDataNodes(final String cmHandle, final String cpsPath,
124 final FetchDescendantsOption fetchDescendantsOption) {
125 return cpsQueryService.queryDataNodes(NF_PROXY_DATASPACE_NAME, cmHandle, cpsPath, fetchDescendantsOption);
129 public void createDataNode(final String cmHandle, final String parentNodeXpath, final String jsonData) {
130 if (!StringUtils.hasText(parentNodeXpath) || "/".equals(parentNodeXpath)) {
131 cpsDataService.saveData(NF_PROXY_DATASPACE_NAME, cmHandle, jsonData, NO_TIMESTAMP);
133 cpsDataService.saveData(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData, NO_TIMESTAMP);
138 public void addListNodeElements(final String cmHandle, final String parentNodeXpath, final String jsonData) {
139 cpsDataService.saveListNodeData(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData, NO_TIMESTAMP);
143 public void updateNodeLeaves(final String cmHandle, final String parentNodeXpath, final String jsonData) {
144 cpsDataService.updateNodeLeaves(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData, NO_TIMESTAMP);
148 public void replaceNodeTree(final String cmHandle, final String parentNodeXpath, final String jsonData) {
149 cpsDataService.replaceNodeTree(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData, NO_TIMESTAMP);
153 public void updateDmiRegistrationAndSyncModule(final DmiPluginRegistration dmiPluginRegistration) {
155 if (dmiPluginRegistration.getCreatedCmHandles() != null) {
156 parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(dmiPluginRegistration);
158 if (dmiPluginRegistration.getUpdatedCmHandles() != null) {
159 parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration);
161 if (dmiPluginRegistration.getRemovedCmHandles() != null) {
162 parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration);
164 } catch (final JsonProcessingException e) {
165 handleJsonProcessingException(dmiPluginRegistration, e);
170 public Object getResourceDataOperationalForCmHandle(final @NotNull String cmHandle,
171 final @NotNull String resourceIdentifier,
172 final String acceptParamInHeader,
173 final String optionsParamInQuery) {
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,
184 return handleResponse(response);
188 public Object getResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle,
189 final @NotNull String resourceIdentifier,
190 final String acceptParamInHeader,
191 final String optionsParamInQuery) {
192 final DataNode cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
193 final String dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get(NCMP_DMI_SERVICE_NAME));
194 final String dmiRequestBody = getGenericRequestBody(cmHandleDataNode);
195 final ResponseEntity<Object> response = dmiOperations.getResourceDataPassThroughRunningFromDmi(dmiServiceName,
201 return handleResponse(response);
205 public void createResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle,
206 final @NotNull String resourceIdentifier,
207 final @NotNull String requestBody,
208 final String contentType) {
209 final DataNode cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
210 final String dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get(NCMP_DMI_SERVICE_NAME));
211 final Collection<DataNode> cmHandlePropertiesAsDataNodes = cmHandleDataNode.getChildDataNodes();
212 final Map<String, String> cmHandlePropertiesAsMap = getCmHandlePropertiesAsMap(cmHandlePropertiesAsDataNodes);
213 final GenericRequestBody dmiRequestBodyObject = GenericRequestBody.builder()
214 .operation(GenericRequestBody.OperationEnum.CREATE)
215 .dataType(contentType)
217 .cmHandleProperties(cmHandlePropertiesAsMap)
219 final String dmiRequestBody = prepareOperationBody(dmiRequestBodyObject);
220 final ResponseEntity<String> responseEntity = dmiOperations
221 .createResourceDataPassThroughRunningFromDmi(dmiServiceName,
225 handleResponseForPost(responseEntity);
229 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandle) {
230 return cpsModuleService.getYangResourcesModuleReferences(NF_PROXY_DATASPACE_NAME, cmHandle);
233 private DataNode fetchDataNodeFromDmiRegistryForCmHandle(final String cmHandle) {
234 final String xpathForDmiRegistryToFetchCmHandle = "/dmi-registry/cm-handles[@id='" + cmHandle + "']";
235 return cpsDataService.getDataNode(NCMP_DATASPACE_NAME,
236 NCMP_DMI_REGISTRY_ANCHOR,
237 xpathForDmiRegistryToFetchCmHandle,
238 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
241 private String prepareOperationBody(final GenericRequestBody requestBodyObject) {
243 return objectMapper.writeValueAsString(requestBodyObject);
244 } catch (final JsonProcessingException e) {
245 log.error("Parsing error occurred while converting Object to JSON.");
246 throw new NcmpException("Parsing error occurred while converting given object to JSON.",
251 private static Map<String, String> getCmHandlePropertiesAsMap(
252 final Collection<DataNode> cmHandlePropertiesAsDataNode) {
253 if (cmHandlePropertiesAsDataNode.isEmpty()) {
254 return Collections.emptyMap();
256 final Map<String, String> cmHandlePropertiesAsMap = new LinkedHashMap<>();
257 for (final DataNode dataNode: cmHandlePropertiesAsDataNode) {
258 cmHandlePropertiesAsMap.put(String.valueOf(dataNode.getLeaves().get("name")),
259 String.valueOf(dataNode.getLeaves().get("value")));
261 return cmHandlePropertiesAsMap;
264 private static Map<String, String> getCmHandlePropertiesAsMap(
265 final List<AdditionalProperty> cmHandlePropertiesAsList) {
266 if (cmHandlePropertiesAsList == null || cmHandlePropertiesAsList.isEmpty()) {
267 return Collections.emptyMap();
269 final Map<String, String> cmHandlePropertiesAsMap = new LinkedHashMap<>();
270 for (final AdditionalProperty additionalProperty: cmHandlePropertiesAsList) {
271 cmHandlePropertiesAsMap.put(additionalProperty.getName(),
272 additionalProperty.getValue());
274 return cmHandlePropertiesAsMap;
277 private static Object handleResponse(final @NotNull ResponseEntity<Object> responseEntity) {
278 if (responseEntity.getStatusCode() == HttpStatus.OK) {
279 return responseEntity.getBody();
281 throw new NcmpException("Not able to get resource data.",
282 "DMI status code: " + responseEntity.getStatusCodeValue()
283 + ", DMI response body: " + responseEntity.getBody());
287 private static void handleResponseForPost(final @NotNull ResponseEntity<String> responseEntity) {
288 if (responseEntity.getStatusCode() != HttpStatus.OK) {
289 throw new NcmpException("Not able to create resource data.",
290 "DMI status code: " + responseEntity.getStatusCodeValue()
291 + ", DMI response body: " + responseEntity.getBody());
295 private String getGenericRequestBody(final DataNode cmHandleDataNode) {
296 final Collection<DataNode> cmHandlePropertiesAsDataNodes = cmHandleDataNode.getChildDataNodes();
297 final Map<String, String> cmHandlePropertiesAsMap = getCmHandlePropertiesAsMap(cmHandlePropertiesAsDataNodes);
298 final GenericRequestBody requestBodyObject = GenericRequestBody.builder()
299 .operation(GenericRequestBody.OperationEnum.READ)
300 .cmHandleProperties(cmHandlePropertiesAsMap)
302 return prepareOperationBody(requestBodyObject);
305 private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration)
306 throws JsonProcessingException {
307 final PersistenceCmHandlesList updatedPersistenceCmHandlesList = toPersistenceCmHandlesList(
308 dmiPluginRegistration.getDmiPlugin(),
309 dmiPluginRegistration.getUpdatedCmHandles());
310 final String cmHandlesAsJson = objectMapper.writeValueAsString(updatedPersistenceCmHandlesList);
311 cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
312 "/dmi-registry", cmHandlesAsJson, NO_TIMESTAMP);
315 private void parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(
316 final DmiPluginRegistration dmiPluginRegistration) throws JsonProcessingException {
317 final PersistenceCmHandlesList createdPersistenceCmHandlesList = toPersistenceCmHandlesList(
318 dmiPluginRegistration.getDmiPlugin(),
319 dmiPluginRegistration.getCreatedCmHandles());
320 registerAndSyncNewCmHandles(createdPersistenceCmHandlesList);
323 private static PersistenceCmHandlesList toPersistenceCmHandlesList(final String dmiPlugin,
324 final Collection<CmHandle> cmHandles) {
325 final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList();
326 for (final CmHandle cmHandle : cmHandles) {
327 final PersistenceCmHandle persistenceCmHandle = toPersistenceCmHandle(dmiPlugin, cmHandle);
328 persistenceCmHandlesList.add(persistenceCmHandle);
330 return persistenceCmHandlesList;
333 private static void handleJsonProcessingException(final DmiPluginRegistration dmiPluginRegistration,
334 final JsonProcessingException e) {
335 final String message = "Parsing error occurred while processing DMI Plugin Registration"
336 + dmiPluginRegistration;
338 throw new DataValidationException(message, e.getMessage(), e);
341 private void registerAndSyncNewCmHandles(final PersistenceCmHandlesList persistenceCmHandlesList)
342 throws JsonProcessingException {
343 final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
344 cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry",
345 cmHandleJsonData, NO_TIMESTAMP);
347 for (final PersistenceCmHandle persistenceCmHandle : persistenceCmHandlesList.getPersistenceCmHandles()) {
348 createAnchorAndSyncModel(persistenceCmHandle);
352 protected void createAnchorAndSyncModel(final PersistenceCmHandle persistenceCmHandle) {
353 createAnchor(persistenceCmHandle);
354 fetchAndSyncModules(persistenceCmHandle);
357 private static PersistenceCmHandle toPersistenceCmHandle(final String dmiPluginService,
358 final CmHandle cmHandle) {
359 final PersistenceCmHandle persistenceCmHandle = new PersistenceCmHandle();
360 persistenceCmHandle.setDmiServiceName(dmiPluginService);
361 persistenceCmHandle.setId(cmHandle.getCmHandleID());
362 if (cmHandle.getCmHandleProperties() == null) {
363 persistenceCmHandle.setAdditionalProperties(Collections.emptyMap());
365 persistenceCmHandle.setAdditionalProperties(cmHandle.getCmHandleProperties());
367 return persistenceCmHandle;
370 private void parseAndRemoveCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
371 for (final String cmHandle : dmiPluginRegistration.getRemovedCmHandles()) {
373 cpsDataService.deleteListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
374 "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
375 } catch (final DataNodeNotFoundException e) {
376 log.warn("Datanode {} not deleted message {}", cmHandle, e.getMessage());
381 private void fetchAndSyncModules(final PersistenceCmHandle persistenceCmHandle) {
382 final Map<String, String> cmHandlePropertiesAsMap = getCmHandlePropertiesAsMap(
383 persistenceCmHandle.getAdditionalProperties());
385 final List<ModuleReference> moduleReferencesFromCmHandle =
386 fetchModuleReferencesFromDmi(persistenceCmHandle, cmHandlePropertiesAsMap);
387 final List<ModuleReference> existingModuleReferences = new ArrayList<>();
388 final List<ModuleReference> unknownModuleReferences = new ArrayList<>();
389 prepareModuleSubsets(moduleReferencesFromCmHandle, existingModuleReferences, unknownModuleReferences);
391 final Map<String, String> newYangResourcesModuleNameToContentMap =
392 getNewYangResourcesFromDmi(persistenceCmHandle, unknownModuleReferences, cmHandlePropertiesAsMap);
394 cpsModuleService.createSchemaSetFromModules(NF_PROXY_DATASPACE_NAME, persistenceCmHandle.getId(),
395 newYangResourcesModuleNameToContentMap, existingModuleReferences);
398 private void prepareModuleSubsets(final List<ModuleReference> moduleReferencesFromCmHandle,
399 final List<ModuleReference> existingModuleReferences,
400 final List<ModuleReference> unknownModuleReferences) {
402 final Collection<ModuleReference> knownModuleReferencesInCps =
403 cpsModuleService.getYangResourceModuleReferences(NF_PROXY_DATASPACE_NAME);
405 for (final ModuleReference moduleReferenceFromDmiForCmHandle : moduleReferencesFromCmHandle) {
406 if (knownModuleReferencesInCps.contains(moduleReferenceFromDmiForCmHandle)) {
407 existingModuleReferences.add(moduleReferenceFromDmiForCmHandle);
409 unknownModuleReferences.add(moduleReferenceFromDmiForCmHandle);
414 private List<ModuleReference> fetchModuleReferencesFromDmi(final PersistenceCmHandle persistenceCmHandle,
415 final Map<String, String> cmHandlePropertiesAsMap) {
416 final GenericRequestBody requestBodyObject = GenericRequestBody.builder()
417 .operation(GenericRequestBody.OperationEnum.READ)
418 .cmHandleProperties(cmHandlePropertiesAsMap)
420 final String jsonBody = prepareOperationBody(requestBodyObject);
421 final ResponseEntity<String> dmiFetchModulesResponseEntity =
422 dmiOperations.getResourceFromDmiWithJsonData(persistenceCmHandle.getDmiServiceName(),
423 jsonBody, persistenceCmHandle.getId(), "modules");
424 return toModuleReferences(dmiFetchModulesResponseEntity);
427 private void createAnchor(final PersistenceCmHandle persistenceCmHandle) {
428 cpsAdminService.createAnchor(NF_PROXY_DATASPACE_NAME, persistenceCmHandle.getId(), persistenceCmHandle.getId());
431 private String getRequestBodyToFetchYangResourceFromDmi(final List<ModuleReference> unknownModuleReferences,
432 final Map<String, String> cmHandlePropertiesAsMap) {
433 final JsonArray moduleReferencesAsJson = getModuleReferencesAsJson(unknownModuleReferences);
434 final JsonObject data = new JsonObject();
435 data.add("modules", moduleReferencesAsJson);
436 final GenericRequestBody dmiRequestBodyObject = GenericRequestBody.builder()
437 .operation(GenericRequestBody.OperationEnum.READ)
438 .dataType(MediaType.APPLICATION_JSON_VALUE)
439 .data(data.toString())
440 .cmHandleProperties(cmHandlePropertiesAsMap)
442 return prepareOperationBody(dmiRequestBodyObject);
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 jsonData = getRequestBodyToFetchYangResourceFromDmi(
461 unknownModuleReferences, cmHandlePropertiesAsMap);
463 final ResponseEntity<String> moduleResourcesAsJsonString = dmiOperations.getResourceFromDmiWithJsonData(
464 persistenceCmHandle.getDmiServiceName(),
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;