cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java

   1 /*
   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  *  ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  10  *
  11  *        http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *
  19  *  SPDX-License-Identifier: Apache-2.0
  20  *  ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.cps.ncmp.api.impl;
  24
  25 import com.fasterxml.jackson.core.JsonProcessingException;
  26 import com.fasterxml.jackson.databind.ObjectMapper;
  27 import java.util.Collection;
  28 import java.util.LinkedHashMap;
  29 import java.util.LinkedList;
  30 import java.util.List;
  31 import java.util.Map;
  32 import javax.validation.constraints.NotNull;
  33 import lombok.extern.slf4j.Slf4j;
  34 import org.onap.cps.api.CpsDataService;
  35 import org.onap.cps.api.CpsQueryService;
  36 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
  37 import org.onap.cps.ncmp.api.impl.exception.NcmpException;
  38 import org.onap.cps.ncmp.api.impl.operation.DmiOperations;
  39 import org.onap.cps.ncmp.api.models.CmHandle;
  40 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
  41 import org.onap.cps.ncmp.api.models.GenericRequestBody;
  42 import org.onap.cps.ncmp.api.models.PersistenceCmHandle;
  43 import org.onap.cps.ncmp.api.models.PersistenceCmHandlesList;
  44 import org.onap.cps.spi.FetchDescendantsOption;
  45 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  46 import org.onap.cps.spi.exceptions.DataValidationException;
  47 import org.onap.cps.spi.model.DataNode;
  48 import org.springframework.http.HttpStatus;
  49 import org.springframework.http.ResponseEntity;
  50 import org.springframework.stereotype.Service;
  51 import org.springframework.util.StringUtils;
  52
  53
  54 @Slf4j
  55 @Service
  56 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
  57
  58     private static final String NF_PROXY_DATASPACE_NAME = "NFP-Operational";
  59
  60     private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
  61
  62     private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
  63
  64     private CpsDataService cpsDataService;
  65
  66     private ObjectMapper objectMapper;
  67
  68     private CpsQueryService cpsQueryService;
  69
  70     private DmiOperations dmiOperations;
  71
  72     /**
  73      * Constructor Injection for Dependencies.
  74      * @param dmiOperations dmi operation
  75      * @param cpsDataService Data Service Interface
  76      * @param cpsQueryService Query Service Interface
  77      * @param objectMapper Object Mapper
  78      */
  79     public NetworkCmProxyDataServiceImpl(final DmiOperations dmiOperations, final CpsDataService cpsDataService,
  80         final CpsQueryService cpsQueryService, final ObjectMapper objectMapper) {
  81         this.dmiOperations = dmiOperations;
  82         this.cpsDataService = cpsDataService;
  83         this.cpsQueryService = cpsQueryService;
  84         this.objectMapper = objectMapper;
  85     }
  86
  87     private String getDataspaceName() {
  88         return NF_PROXY_DATASPACE_NAME;
  89     }
  90
  91     @Override
  92     public DataNode getDataNode(final String cmHandle, final String xpath,
  93         final FetchDescendantsOption fetchDescendantsOption) {
  94         return cpsDataService.getDataNode(getDataspaceName(), cmHandle, xpath, fetchDescendantsOption);
  95     }
  96
  97     @Override
  98     public Collection<DataNode> queryDataNodes(final String cmHandle, final String cpsPath,
  99                                                final FetchDescendantsOption fetchDescendantsOption) {
 100         return cpsQueryService.queryDataNodes(getDataspaceName(), cmHandle, cpsPath, fetchDescendantsOption);
 101     }
 102
 103     @Override
 104     public void createDataNode(final String cmHandle, final String parentNodeXpath, final String jsonData) {
 105         if (!StringUtils.hasText(parentNodeXpath) || "/".equals(parentNodeXpath)) {
 106             cpsDataService.saveData(getDataspaceName(), cmHandle, jsonData);
 107         } else {
 108             cpsDataService.saveData(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
 109         }
 110     }
 111
 112     @Override
 113     public void addListNodeElements(final String cmHandle, final String parentNodeXpath, final String jsonData) {
 114         cpsDataService.saveListNodeData(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
 115     }
 116
 117     @Override
 118     public void updateNodeLeaves(final String cmHandle, final String parentNodeXpath, final String jsonData) {
 119         cpsDataService.updateNodeLeaves(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
 120     }
 121
 122     @Override
 123     public void replaceNodeTree(final String cmHandle, final String parentNodeXpath, final String jsonData) {
 124         cpsDataService.replaceNodeTree(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
 125     }
 126
 127     @Override
 128     public void updateDmiPluginRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 129         if (dmiPluginRegistration.getCreatedCmHandles() != null) {
 130             parseAndCreateCmHandlesInDmiRegistration(dmiPluginRegistration);
 131         }
 132         if (dmiPluginRegistration.getUpdatedCmHandles() != null) {
 133             parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration);
 134         }
 135         if (dmiPluginRegistration.getRemovedCmHandles() != null) {
 136             parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration);
 137         }
 138     }
 139
 140     private void parseAndCreateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 141         try {
 142             final List<PersistenceCmHandle> createdPersistenceCmHandles =
 143                 new LinkedList<>();
 144             for (final CmHandle cmHandle: dmiPluginRegistration.getCreatedCmHandles()) {
 145                 createdPersistenceCmHandles.add(toPersistenceCmHandle(dmiPluginRegistration, cmHandle));
 146             }
 147             final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList();
 148             persistenceCmHandlesList.setCmHandles(createdPersistenceCmHandles);
 149             final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
 150             cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry",
 151                 cmHandleJsonData);
 152         } catch (final JsonProcessingException e) {
 153             log.error("Parsing error occurred while converting Object to JSON for Dmi Registry.");
 154             throw new DataValidationException(
 155                 "Parsing error occurred while processing DMI Plugin Registration" + dmiPluginRegistration, e
 156                 .getMessage(), e);
 157         }
 158     }
 159
 160     private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 161         try {
 162             final List<PersistenceCmHandle> updatedPersistenceCmHandles =
 163                 new LinkedList<>();
 164             for (final CmHandle cmHandle: dmiPluginRegistration.getUpdatedCmHandles()) {
 165                 updatedPersistenceCmHandles.add(toPersistenceCmHandle(dmiPluginRegistration, cmHandle));
 166             }
 167             final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList();
 168             persistenceCmHandlesList.setCmHandles(updatedPersistenceCmHandles);
 169             final String cmHandlesJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
 170             cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 171                 "/dmi-registry", cmHandlesJsonData);
 172         } catch (final JsonProcessingException e) {
 173             log.error("Parsing error occurred while converting Object to JSON Dmi Registry.");
 174             throw new DataValidationException(
 175                 "Parsing error occurred while processing DMI Plugin Registration" + dmiPluginRegistration, e
 176                 .getMessage(), e);
 177         }
 178     }
 179
 180     private void parseAndRemoveCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 181         for (final String cmHandle: dmiPluginRegistration.getRemovedCmHandles()) {
 182             try {
 183                 cpsDataService.deleteListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 184                     "/dmi-registry/cm-handles[@id='" + cmHandle + "']");
 185             } catch (final DataNodeNotFoundException e) {
 186                 log.warn("Datanode {} not deleted message {}", cmHandle, e.getMessage());
 187             }
 188         }
 189     }
 190
 191     @Override
 192     public Object getResourceDataOperationalForCmHandle(final @NotNull String cmHandle,
 193                                                         final @NotNull String resourceIdentifier,
 194                                                         final String acceptParam,
 195                                                         final String fieldsQueryParam,
 196                                                         final Integer depthQueryParam) {
 197
 198         final var dataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
 199         final var dmiServiceName = String.valueOf(dataNode.getLeaves().get("dmi-service-name"));
 200         final Collection<DataNode> additionalPropsList = dataNode.getChildDataNodes();
 201         final var jsonBody = prepareOperationBody(GenericRequestBody.OperationEnum.READ, additionalPropsList);
 202         final ResponseEntity<Object> response = dmiOperations.getResouceDataOperationalFromDmi(dmiServiceName,
 203                 cmHandle,
 204                 resourceIdentifier,
 205                 fieldsQueryParam,
 206                 depthQueryParam,
 207                 acceptParam,
 208                 jsonBody);
 209         return handleResponse(response);
 210     }
 211
 212     @Override
 213     public Object getResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle,
 214                                                                final @NotNull String resourceIdentifier,
 215                                                                final String accept,
 216                                                                final String fields,
 217                                                                final Integer depth) {
 218         final var cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
 219         final var dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get("dmi-service-name"));
 220         final Collection<DataNode> additionalPropsList = cmHandleDataNode.getChildDataNodes();
 221         final var dmiRequesBody = prepareOperationBody(GenericRequestBody.OperationEnum.READ, additionalPropsList);
 222         final ResponseEntity<Object> response = dmiOperations.getResouceDataPassThroughRunningFromDmi(dmiServiceName,
 223                 cmHandle,
 224                 resourceIdentifier,
 225                 fields,
 226                 depth,
 227                 accept,
 228                 dmiRequesBody);
 229         return handleResponse(response);
 230     }
 231
 232     private DataNode fetchDataNodeFromDmiRegistryForCmHandle(final String cmHandle) {
 233         final String xpathForDmiRegistryToFetchCmHandle = "/dmi-registry/cm-handles[@id='" + cmHandle + "']";
 234         final var dataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME,
 235                 NCMP_DMI_REGISTRY_ANCHOR,
 236                 xpathForDmiRegistryToFetchCmHandle,
 237                 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
 238         return dataNode;
 239     }
 240
 241     private String prepareOperationBody(final GenericRequestBody.OperationEnum operation,
 242                                         final Collection<DataNode> additionalPropertyList) {
 243         final var requestBody = new GenericRequestBody();
 244         final Map<String, String> additionalPropertyMap = getAdditionalPropertiesMap(additionalPropertyList);
 245         requestBody.setOperation(GenericRequestBody.OperationEnum.READ);
 246         requestBody.setCmHandleProperties(additionalPropertyMap);
 247         try {
 248             final var requestJson = objectMapper.writeValueAsString(requestBody);
 249             return requestJson;
 250         } catch (final JsonProcessingException je) {
 251             log.error("Parsing error occurred while converting Object to JSON.");
 252             throw new NcmpException("Parsing error occurred while converting given object to JSON.",
 253                     je.getMessage());
 254         }
 255     }
 256
 257     private Map<String, String> getAdditionalPropertiesMap(final Collection<DataNode> additionalPropertyList) {
 258         if (additionalPropertyList == null || additionalPropertyList.size() == 0) {
 259             return null;
 260         }
 261         final Map<String, String> additionalPropertyMap = new LinkedHashMap<>();
 262         for (final var node: additionalPropertyList) {
 263             additionalPropertyMap.put(String.valueOf(node.getLeaves().get("name")),
 264                     String.valueOf(node.getLeaves().get("value")));
 265         }
 266         return additionalPropertyMap;
 267     }
 268
 269     private Object handleResponse(final ResponseEntity<Object> responseEntity) {
 270         if (responseEntity.getStatusCode() == HttpStatus.OK) {
 271             return responseEntity.getBody();
 272         } else {
 273             throw new NcmpException("Not able to get resource data.",
 274                     "DMI status code: " + responseEntity.getStatusCodeValue()
 275                             + ", DMI response body: " + responseEntity.getBody());
 276         }
 277     }
 278
 279     private PersistenceCmHandle toPersistenceCmHandle(final DmiPluginRegistration dmiPluginRegistration,
 280                                                       final CmHandle cmHandle) {
 281         final PersistenceCmHandle persistenceCmHandle = new PersistenceCmHandle();
 282         persistenceCmHandle.setDmiServiceName(dmiPluginRegistration.getDmiPlugin());
 283         persistenceCmHandle.setId(cmHandle.getCmHandleID());
 284         persistenceCmHandle.setAdditionalProperties(cmHandle.getCmHandleProperties());
 285         return persistenceCmHandle;
 286     }
 287
 288 }