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.DataValidationException;
  46 import org.onap.cps.spi.model.DataNode;
  47 import org.springframework.http.HttpStatus;
  48 import org.springframework.http.ResponseEntity;
  49 import org.springframework.stereotype.Service;
  50 import org.springframework.util.StringUtils;
  51
  52
  53 @Slf4j
  54 @Service
  55 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
  56
  57     private static final String NF_PROXY_DATASPACE_NAME = "NFP-Operational";
  58
  59     private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
  60
  61     private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
  62
  63     private CpsDataService cpsDataService;
  64
  65     private ObjectMapper objectMapper;
  66
  67     private CpsQueryService cpsQueryService;
  68
  69     private DmiOperations dmiOperations;
  70
  71     /**
  72      * Constructor Injection for Dependencies.
  73      * @param dmiOperations dmi operation
  74      * @param cpsDataService Data Service Interface
  75      * @param cpsQueryService Query Service Interface
  76      * @param objectMapper Object Mapper
  77      */
  78     public NetworkCmProxyDataServiceImpl(final DmiOperations dmiOperations, final CpsDataService cpsDataService,
  79         final CpsQueryService cpsQueryService, final ObjectMapper objectMapper) {
  80         this.dmiOperations = dmiOperations;
  81         this.cpsDataService = cpsDataService;
  82         this.cpsQueryService = cpsQueryService;
  83         this.objectMapper = objectMapper;
  84     }
  85
  86     private String getDataspaceName() {
  87         return NF_PROXY_DATASPACE_NAME;
  88     }
  89
  90     @Override
  91     public DataNode getDataNode(final String cmHandle, final String xpath,
  92         final FetchDescendantsOption fetchDescendantsOption) {
  93         return cpsDataService.getDataNode(getDataspaceName(), cmHandle, xpath, fetchDescendantsOption);
  94     }
  95
  96     @Override
  97     public Collection<DataNode> queryDataNodes(final String cmHandle, final String cpsPath,
  98                                                final FetchDescendantsOption fetchDescendantsOption) {
  99         return cpsQueryService.queryDataNodes(getDataspaceName(), cmHandle, cpsPath, fetchDescendantsOption);
 100     }
 101
 102     @Override
 103     public void createDataNode(final String cmHandle, final String parentNodeXpath, final String jsonData) {
 104         if (!StringUtils.hasText(parentNodeXpath) || "/".equals(parentNodeXpath)) {
 105             cpsDataService.saveData(getDataspaceName(), cmHandle, jsonData);
 106         } else {
 107             cpsDataService.saveData(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
 108         }
 109     }
 110
 111     @Override
 112     public void addListNodeElements(final String cmHandle, final String parentNodeXpath, final String jsonData) {
 113         cpsDataService.saveListNodeData(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
 114     }
 115
 116     @Override
 117     public void updateNodeLeaves(final String cmHandle, final String parentNodeXpath, final String jsonData) {
 118         cpsDataService.updateNodeLeaves(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
 119     }
 120
 121     @Override
 122     public void replaceNodeTree(final String cmHandle, final String parentNodeXpath, final String jsonData) {
 123         cpsDataService.replaceNodeTree(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
 124     }
 125
 126     @Override
 127     public void updateDmiPluginRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 128         if (dmiPluginRegistration.getCreatedCmHandles() != null) {
 129             parseAndCreateCmHandlesInDmiRegistration(dmiPluginRegistration);
 130         }
 131         if (dmiPluginRegistration.getUpdatedCmHandles() != null) {
 132             parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration);
 133         }
 134     }
 135
 136     private void parseAndCreateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 137         try {
 138             final List<PersistenceCmHandle> createdPersistenceCmHandles =
 139                 new LinkedList<>();
 140             for (final CmHandle cmHandle: dmiPluginRegistration.getCreatedCmHandles()) {
 141                 createdPersistenceCmHandles.add(toPersistenceCmHandle(dmiPluginRegistration, cmHandle));
 142             }
 143             final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList();
 144             persistenceCmHandlesList.setCmHandles(createdPersistenceCmHandles);
 145             final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
 146             cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry",
 147                 cmHandleJsonData);
 148         } catch (final JsonProcessingException e) {
 149             log.error("Parsing error occurred while converting Object to JSON for Dmi Registry.");
 150             throw new DataValidationException(
 151                 "Parsing error occurred while processing DMI Plugin Registration" + dmiPluginRegistration, e
 152                 .getMessage(), e);
 153         }
 154     }
 155
 156     private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 157         try {
 158             final List<PersistenceCmHandle> updatedPersistenceCmHandles =
 159                 new LinkedList<>();
 160             for (final CmHandle cmHandle: dmiPluginRegistration.getUpdatedCmHandles()) {
 161                 updatedPersistenceCmHandles.add(toPersistenceCmHandle(dmiPluginRegistration, cmHandle));
 162             }
 163             final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList();
 164             persistenceCmHandlesList.setCmHandles(updatedPersistenceCmHandles);
 165             final String cmHandlesJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
 166             cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 167                 "/dmi-registry", cmHandlesJsonData);
 168         } catch (final JsonProcessingException e) {
 169             log.error("Parsing error occurred while converting Object to JSON Dmi Registry.");
 170             throw new DataValidationException(
 171                 "Parsing error occurred while processing DMI Plugin Registration" + dmiPluginRegistration, e
 172                 .getMessage(), e);
 173         }
 174     }
 175
 176     @Override
 177     public Object getResourceDataOperationalForCmHandle(final @NotNull String cmHandle,
 178                                                         final @NotNull String resourceIdentifier,
 179                                                         final String acceptParam,
 180                                                         final String fieldsQueryParam,
 181                                                         final Integer depthQueryParam) {
 182
 183         final var dataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
 184         final var dmiServiceName = String.valueOf(dataNode.getLeaves().get("dmi-service-name"));
 185         final Collection<DataNode> additionalPropsList = dataNode.getChildDataNodes();
 186         final var jsonBody = prepareOperationBody(GenericRequestBody.OperationEnum.READ, additionalPropsList);
 187         final ResponseEntity<Object> response = dmiOperations.getResouceDataOperationalFromDmi(dmiServiceName,
 188                 cmHandle,
 189                 resourceIdentifier,
 190                 fieldsQueryParam,
 191                 depthQueryParam,
 192                 acceptParam,
 193                 jsonBody);
 194         return handleResponse(response);
 195     }
 196
 197     @Override
 198     public Object getResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle,
 199                                                                final @NotNull String resourceIdentifier,
 200                                                                final String accept,
 201                                                                final String fields,
 202                                                                final Integer depth) {
 203         final var cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
 204         final var dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get("dmi-service-name"));
 205         final Collection<DataNode> additionalPropsList = cmHandleDataNode.getChildDataNodes();
 206         final var dmiRequesBody = prepareOperationBody(GenericRequestBody.OperationEnum.READ, additionalPropsList);
 207         final ResponseEntity<Object> response = dmiOperations.getResouceDataPassThroughRunningFromDmi(dmiServiceName,
 208                 cmHandle,
 209                 resourceIdentifier,
 210                 fields,
 211                 depth,
 212                 accept,
 213                 dmiRequesBody);
 214         return handleResponse(response);
 215     }
 216
 217     private DataNode fetchDataNodeFromDmiRegistryForCmHandle(final String cmHandle) {
 218         final String xpathForDmiRegistryToFetchCmHandle = "/dmi-registry/cm-handles[@id='" + cmHandle + "']";
 219         final var dataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME,
 220                 NCMP_DMI_REGISTRY_ANCHOR,
 221                 xpathForDmiRegistryToFetchCmHandle,
 222                 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
 223         return dataNode;
 224     }
 225
 226     private String prepareOperationBody(final GenericRequestBody.OperationEnum operation,
 227                                         final Collection<DataNode> additionalPropertyList) {
 228         final var requestBody = new GenericRequestBody();
 229         final Map<String, String> additionalPropertyMap = getAdditionalPropertiesMap(additionalPropertyList);
 230         requestBody.setOperation(GenericRequestBody.OperationEnum.READ);
 231         requestBody.setCmHandleProperties(additionalPropertyMap);
 232         try {
 233             final var requestJson = objectMapper.writeValueAsString(requestBody);
 234             return requestJson;
 235         } catch (final JsonProcessingException je) {
 236             log.error("Parsing error occurred while converting Object to JSON.");
 237             throw new NcmpException("Parsing error occurred while converting given object to JSON.",
 238                     je.getMessage());
 239         }
 240     }
 241
 242     private Map<String, String> getAdditionalPropertiesMap(final Collection<DataNode> additionalPropertyList) {
 243         if (additionalPropertyList == null || additionalPropertyList.size() == 0) {
 244             return null;
 245         }
 246         final Map<String, String> additionalPropertyMap = new LinkedHashMap<>();
 247         for (final var node: additionalPropertyList) {
 248             additionalPropertyMap.put(String.valueOf(node.getLeaves().get("name")),
 249                     String.valueOf(node.getLeaves().get("value")));
 250         }
 251         return additionalPropertyMap;
 252     }
 253
 254     private Object handleResponse(final ResponseEntity<Object> responseEntity) {
 255         if (responseEntity.getStatusCode() == HttpStatus.OK) {
 256             return responseEntity.getBody();
 257         } else {
 258             throw new NcmpException("Not able to get resource data.",
 259                     "DMI status code: " + responseEntity.getStatusCodeValue()
 260                             + ", DMI response body: " + responseEntity.getBody());
 261         }
 262     }
 263
 264     private PersistenceCmHandle toPersistenceCmHandle(final DmiPluginRegistration dmiPluginRegistration,
 265                                                       final CmHandle cmHandle) {
 266         final PersistenceCmHandle persistenceCmHandle = new PersistenceCmHandle();
 267         persistenceCmHandle.setDmiServiceName(dmiPluginRegistration.getDmiPlugin());
 268         persistenceCmHandle.setId(cmHandle.getCmHandleID());
 269         persistenceCmHandle.setAdditionalProperties(cmHandle.getCmHandleProperties());
 270         return persistenceCmHandle;
 271     }
 272
 273 }