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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2022 Nordix Foundation
   4  *  Modifications Copyright (C) 2020-2022 Bell Canada.
   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.api.impl;
  24
  25 import static org.onap.cps.notification.Operation.CREATE;
  26 import static org.onap.cps.notification.Operation.DELETE;
  27 import static org.onap.cps.notification.Operation.UPDATE;
  28
  29 import java.time.OffsetDateTime;
  30 import java.util.Collection;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.stream.Collectors;
  34 import lombok.AllArgsConstructor;
  35 import lombok.extern.slf4j.Slf4j;
  36 import org.onap.cps.api.CpsAdminService;
  37 import org.onap.cps.api.CpsDataService;
  38 import org.onap.cps.notification.NotificationService;
  39 import org.onap.cps.notification.Operation;
  40 import org.onap.cps.spi.CpsDataPersistenceService;
  41 import org.onap.cps.spi.FetchDescendantsOption;
  42 import org.onap.cps.spi.exceptions.DataValidationException;
  43 import org.onap.cps.spi.model.Anchor;
  44 import org.onap.cps.spi.model.DataNode;
  45 import org.onap.cps.spi.model.DataNodeBuilder;
  46 import org.onap.cps.utils.CpsValidator;
  47 import org.onap.cps.utils.YangUtils;
  48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  50 import org.springframework.stereotype.Service;
  51
  52 @Service
  53 @Slf4j
  54 @AllArgsConstructor
  55 public class CpsDataServiceImpl implements CpsDataService {
  56
  57     private static final String ROOT_NODE_XPATH = "/";
  58     private static final long DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS = 300L;
  59
  60     private final CpsDataPersistenceService cpsDataPersistenceService;
  61     private final CpsAdminService cpsAdminService;
  62     private final YangTextSchemaSourceSetCache yangTextSchemaSourceSetCache;
  63     private final NotificationService notificationService;
  64
  65     @Override
  66     public void saveData(final String dataspaceName, final String anchorName, final String jsonData,
  67         final OffsetDateTime observedTimestamp) {
  68         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
  69         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, ROOT_NODE_XPATH, jsonData);
  70         cpsDataPersistenceService.storeDataNode(dataspaceName, anchorName, dataNode);
  71         processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, CREATE, observedTimestamp);
  72     }
  73
  74     @Override
  75     public void saveData(final String dataspaceName, final String anchorName, final String parentNodeXpath,
  76         final String jsonData, final OffsetDateTime observedTimestamp) {
  77         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
  78         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
  79         cpsDataPersistenceService.addChildDataNode(dataspaceName, anchorName, parentNodeXpath, dataNode);
  80         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, CREATE, observedTimestamp);
  81     }
  82
  83     @Override
  84     public void saveListElements(final String dataspaceName, final String anchorName,
  85         final String parentNodeXpath, final String jsonData, final OffsetDateTime observedTimestamp) {
  86         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
  87         final Collection<DataNode> listElementDataNodeCollection =
  88             buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
  89         cpsDataPersistenceService.addListElements(dataspaceName, anchorName, parentNodeXpath,
  90             listElementDataNodeCollection);
  91         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
  92     }
  93
  94     @Override
  95     public DataNode getDataNode(final String dataspaceName, final String anchorName, final String xpath,
  96         final FetchDescendantsOption fetchDescendantsOption) {
  97         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
  98         return cpsDataPersistenceService.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption);
  99     }
 100
 101     @Override
 102     public void updateNodeLeaves(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 103         final String jsonData, final OffsetDateTime observedTimestamp) {
 104         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 105         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
 106         cpsDataPersistenceService
 107             .updateDataLeaves(dataspaceName, anchorName, dataNode.getXpath(), dataNode.getLeaves());
 108         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 109     }
 110
 111     @Override
 112     public void updateNodeLeavesAndExistingDescendantLeaves(final String dataspaceName, final String anchorName,
 113         final String parentNodeXpath,
 114         final String dataNodeUpdatesAsJson,
 115         final OffsetDateTime observedTimestamp) {
 116         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 117         final Collection<DataNode> dataNodeUpdates =
 118             buildDataNodes(dataspaceName, anchorName,
 119                 parentNodeXpath, dataNodeUpdatesAsJson);
 120         for (final DataNode dataNodeUpdate : dataNodeUpdates) {
 121             processDataNodeUpdate(dataspaceName, anchorName, dataNodeUpdate);
 122         }
 123         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 124     }
 125
 126     @Override
 127     public String startSession() {
 128         return cpsDataPersistenceService.startSession();
 129     }
 130
 131     @Override
 132     public void closeSession(final String sessionId) {
 133         cpsDataPersistenceService.closeSession(sessionId);
 134     }
 135
 136     @Override
 137     public void lockAnchor(final String sessionID, final String dataspaceName, final String anchorName) {
 138         lockAnchor(sessionID, dataspaceName, anchorName, DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS);
 139     }
 140
 141     @Override
 142     public void lockAnchor(final String sessionID, final String dataspaceName,
 143                            final String anchorName, final Long timeoutInMilliseconds) {
 144         cpsDataPersistenceService.lockAnchor(sessionID, dataspaceName, anchorName, timeoutInMilliseconds);
 145     }
 146
 147     @Override
 148     public void updateDataNodeAndDescendants(final String dataspaceName, final String anchorName,
 149                                              final String parentNodeXpath, final String jsonData,
 150                                              final OffsetDateTime observedTimestamp) {
 151         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 152         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
 153         cpsDataPersistenceService.updateDataNodeAndDescendants(dataspaceName, anchorName, dataNode);
 154         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 155     }
 156
 157     @Override
 158     public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
 159                                               final Map<String, String> nodesJsonData,
 160                                               final OffsetDateTime observedTimestamp) {
 161         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 162         final List<DataNode> dataNodes = buildDataNodes(dataspaceName, anchorName, nodesJsonData);
 163         cpsDataPersistenceService.updateDataNodesAndDescendants(dataspaceName, anchorName, dataNodes);
 164         nodesJsonData.keySet().forEach(nodeXpath ->
 165             processDataUpdatedEventAsync(dataspaceName, anchorName, nodeXpath,
 166                 UPDATE, observedTimestamp));
 167     }
 168
 169     @Override
 170     public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 171             final String jsonData, final OffsetDateTime observedTimestamp) {
 172         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 173         final Collection<DataNode> newListElements =
 174                 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
 175         replaceListContent(dataspaceName, anchorName, parentNodeXpath, newListElements, observedTimestamp);
 176     }
 177
 178     @Override
 179     public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 180             final Collection<DataNode> dataNodes, final OffsetDateTime observedTimestamp) {
 181         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 182         cpsDataPersistenceService.replaceListContent(dataspaceName, anchorName, parentNodeXpath, dataNodes);
 183         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 184     }
 185
 186     @Override
 187     public void deleteDataNode(final String dataspaceName, final String anchorName, final String dataNodeXpath,
 188                                final OffsetDateTime observedTimestamp) {
 189         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 190         cpsDataPersistenceService.deleteDataNode(dataspaceName, anchorName, dataNodeXpath);
 191         processDataUpdatedEventAsync(dataspaceName, anchorName, dataNodeXpath, DELETE, observedTimestamp);
 192     }
 193
 194     @Override
 195     public void deleteDataNodes(final String dataspaceName, final String anchorName,
 196         final OffsetDateTime observedTimestamp) {
 197         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 198         processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, DELETE, observedTimestamp);
 199         cpsDataPersistenceService.deleteDataNodes(dataspaceName, anchorName);
 200     }
 201
 202     @Override
 203     public void deleteListOrListElement(final String dataspaceName, final String anchorName, final String listNodeXpath,
 204         final OffsetDateTime observedTimestamp) {
 205         CpsValidator.validateNameCharacters(dataspaceName, anchorName);
 206         cpsDataPersistenceService.deleteListDataNode(dataspaceName, anchorName, listNodeXpath);
 207         processDataUpdatedEventAsync(dataspaceName, anchorName, listNodeXpath, DELETE, observedTimestamp);
 208     }
 209
 210     private DataNode buildDataNode(final String dataspaceName, final String anchorName,
 211                                    final String parentNodeXpath, final String jsonData) {
 212
 213         final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 214         final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
 215
 216         if (ROOT_NODE_XPATH.equals(parentNodeXpath)) {
 217             final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext);
 218             return new DataNodeBuilder().withNormalizedNodeTree(normalizedNode).build();
 219         }
 220
 221         final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath);
 222         return new DataNodeBuilder()
 223             .withParentNodeXpath(parentNodeXpath)
 224             .withNormalizedNodeTree(normalizedNode)
 225             .build();
 226     }
 227
 228     private List<DataNode> buildDataNodes(final String dataspaceName, final String anchorName,
 229                                           final Map<String, String> nodesJsonData) {
 230         return nodesJsonData.entrySet().stream().map(nodeJsonData ->
 231             buildDataNode(dataspaceName, anchorName, nodeJsonData.getKey(),
 232                 nodeJsonData.getValue())).collect(Collectors.toList());
 233     }
 234
 235     private Collection<DataNode> buildDataNodes(final String dataspaceName,
 236                                                 final String anchorName,
 237                                                 final String parentNodeXpath,
 238                                                 final String jsonData) {
 239
 240         final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 241         final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
 242
 243         final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath);
 244         final Collection<DataNode> dataNodes = new DataNodeBuilder()
 245             .withParentNodeXpath(parentNodeXpath)
 246             .withNormalizedNodeTree(normalizedNode)
 247             .buildCollection();
 248         if (dataNodes.isEmpty()) {
 249             throw new DataValidationException("Invalid data.", "No data nodes provided");
 250         }
 251         return dataNodes;
 252
 253     }
 254
 255     private void processDataUpdatedEventAsync(final String dataspaceName, final String anchorName, final String xpath,
 256             final Operation operation, final OffsetDateTime observedTimestamp) {
 257         try {
 258             notificationService.processDataUpdatedEvent(dataspaceName, anchorName, xpath, operation, observedTimestamp);
 259         } catch (final Exception exception) {
 260             //If async message can't be queued for notification service, the initial request should not failed.
 261             log.error("Failed to send message to notification service", exception);
 262         }
 263     }
 264
 265     private SchemaContext getSchemaContext(final String dataspaceName, final String schemaSetName) {
 266         return yangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName).getSchemaContext();
 267     }
 268
 269     private void processDataNodeUpdate(final String dataspaceName, final String anchorName,
 270                                        final DataNode dataNodeUpdate) {
 271         if (dataNodeUpdate == null) {
 272             return;
 273         }
 274         cpsDataPersistenceService.updateDataLeaves(dataspaceName, anchorName, dataNodeUpdate.getXpath(),
 275             dataNodeUpdate.getLeaves());
 276         final Collection<DataNode> childDataNodeUpdates = dataNodeUpdate.getChildDataNodes();
 277         for (final DataNode childDataNodeUpdate : childDataNodeUpdates) {
 278             processDataNodeUpdate(dataspaceName, anchorName, childDataNodeUpdate);
 279         }
 280     }
 281
 282 }