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.ArrayList;
  28 import java.util.Collection;
  29 import java.util.LinkedHashMap;
  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         try {
 129             final List<PersistenceCmHandle> persistenceCmHandles =
 130                 new ArrayList<>();
 131             for (final CmHandle cmHandle: dmiPluginRegistration.getCreatedCmHandles()) {
 132                 final var persistenceCmHandle = new PersistenceCmHandle();
 133                 persistenceCmHandle.setDmiServiceName(dmiPluginRegistration.getDmiPlugin());
 134                 persistenceCmHandle.setId(cmHandle.getCmHandleID());
 135                 persistenceCmHandle.setAdditionalProperties(cmHandle.getCmHandleProperties());
 136                 persistenceCmHandles.add(persistenceCmHandle);
 137             }
 138             final var persistenceCmHandlesList = new PersistenceCmHandlesList();
 139             persistenceCmHandlesList.setCmHandles(persistenceCmHandles);
 140             final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
 141             cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME,
 142                     NCMP_DMI_REGISTRY_ANCHOR,
 143                     "/dmi-registry",
 144                 cmHandleJsonData);
 145         } catch (final JsonProcessingException e) {
 146             throw new DataValidationException(
 147                 "Parsing error occurred while processing DMI Plugin Registration" + dmiPluginRegistration, e
 148                 .getMessage(), e);
 149         }
 150     }
 151
 152     @Override
 153     public Object getResourceDataOperationalForCmHandle(final @NotNull String cmHandle,
 154                                                         final @NotNull String resourceIdentifier,
 155                                                         final String acceptParam,
 156                                                         final String fieldsQueryParam,
 157                                                         final Integer depthQueryParam) {
 158
 159         final var dataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
 160         final var dmiServiceName = String.valueOf(dataNode.getLeaves().get("dmi-service-name"));
 161         final Collection<DataNode> additionalPropsList = dataNode.getChildDataNodes();
 162         final var jsonBody = prepareOperationBody(GenericRequestBody.OperationEnum.READ, additionalPropsList);
 163         final ResponseEntity<Object> response = dmiOperations.getResouceDataOperationalFromDmi(dmiServiceName,
 164                 cmHandle,
 165                 resourceIdentifier,
 166                 fieldsQueryParam,
 167                 depthQueryParam,
 168                 acceptParam,
 169                 jsonBody);
 170         return handleResponse(response);
 171     }
 172
 173     @Override
 174     public Object getResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle,
 175                                                                final @NotNull String resourceIdentifier,
 176                                                                final String accept,
 177                                                                final String fields,
 178                                                                final Integer depth) {
 179         final var cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle);
 180         final var dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get("dmi-service-name"));
 181         final Collection<DataNode> additionalPropsList = cmHandleDataNode.getChildDataNodes();
 182         final var dmiRequesBody = prepareOperationBody(GenericRequestBody.OperationEnum.READ, additionalPropsList);
 183         final ResponseEntity<Object> response = dmiOperations.getResouceDataPassThroughRunningFromDmi(dmiServiceName,
 184                 cmHandle,
 185                 resourceIdentifier,
 186                 fields,
 187                 depth,
 188                 accept,
 189                 dmiRequesBody);
 190         return handleResponse(response);
 191     }
 192
 193     private DataNode fetchDataNodeFromDmiRegistryForCmHandle(final String cmHandle) {
 194         final String xpathForDmiRegistryToFetchCmHandle = "/dmi-registry/cm-handles[@id='" + cmHandle + "']";
 195         final var dataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME,
 196                 NCMP_DMI_REGISTRY_ANCHOR,
 197                 xpathForDmiRegistryToFetchCmHandle,
 198                 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
 199         return dataNode;
 200     }
 201
 202     private String prepareOperationBody(final GenericRequestBody.OperationEnum operation,
 203                                         final Collection<DataNode> additionalPropertyList) {
 204         final var requestBody = new GenericRequestBody();
 205         final Map<String, String> additionalPropertyMap = getAdditionalPropertiesMap(additionalPropertyList);
 206         requestBody.setOperation(GenericRequestBody.OperationEnum.READ);
 207         requestBody.setCmHandleProperties(additionalPropertyMap);
 208         try {
 209             final var requestJson = objectMapper.writeValueAsString(requestBody);
 210             return requestJson;
 211         } catch (final JsonProcessingException je) {
 212             log.error("Parsing error occurred while converting Object to JSON.");
 213             throw new NcmpException("Parsing error occurred while converting given object to JSON.",
 214                     je.getMessage());
 215         }
 216     }
 217
 218     private Map<String, String> getAdditionalPropertiesMap(final Collection<DataNode> additionalPropertyList) {
 219         if (additionalPropertyList == null || additionalPropertyList.size() == 0) {
 220             return null;
 221         }
 222         final Map<String, String> additionalPropertyMap = new LinkedHashMap<>();
 223         for (final var node: additionalPropertyList) {
 224             additionalPropertyMap.put(String.valueOf(node.getLeaves().get("name")),
 225                     String.valueOf(node.getLeaves().get("value")));
 226         }
 227         return additionalPropertyMap;
 228     }
 229
 230     private Object handleResponse(final ResponseEntity<Object> responseEntity) {
 231         if (responseEntity.getStatusCode() == HttpStatus.OK) {
 232             return responseEntity.getBody();
 233         } else {
 234             throw new NcmpException("Not able to get resource data.",
 235                     "DMI status code: " + responseEntity.getStatusCodeValue()
 236                             + ", DMI response body: " + responseEntity.getBody());
 237         }
 238     }
 239
 240
 241 }