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  *  Modifications Copyright (C) 2022 TechMahindra Ltd.
   7  *  Modifications Copyright (C) 2022 Deutsche Telekom AG
   8  *  ================================================================================
   9  *  Licensed under the Apache License, Version 2.0 (the "License");
  10  *  you may not use this file except in compliance with the License.
  11  *  You may obtain a copy of the License at
  12  *
  13  *        http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  *  Unless required by applicable law or agreed to in writing, software
  16  *  distributed under the License is distributed on an "AS IS" BASIS,
  17  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  *  See the License for the specific language governing permissions and
  19  *  limitations under the License.
  20  *
  21  *  SPDX-License-Identifier: Apache-2.0
  22  *  ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.cps.api.impl;
  26
  27 import static org.onap.cps.notification.Operation.CREATE;
  28 import static org.onap.cps.notification.Operation.DELETE;
  29 import static org.onap.cps.notification.Operation.UPDATE;
  30
  31 import java.time.OffsetDateTime;
  32 import java.util.ArrayList;
  33 import java.util.Collection;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.stream.Collectors;
  37 import lombok.RequiredArgsConstructor;
  38 import lombok.extern.slf4j.Slf4j;
  39 import org.onap.cps.api.CpsAdminService;
  40 import org.onap.cps.api.CpsDataService;
  41 import org.onap.cps.notification.NotificationService;
  42 import org.onap.cps.notification.Operation;
  43 import org.onap.cps.spi.CpsDataPersistenceService;
  44 import org.onap.cps.spi.FetchDescendantsOption;
  45 import org.onap.cps.spi.exceptions.DataValidationException;
  46 import org.onap.cps.spi.model.Anchor;
  47 import org.onap.cps.spi.model.DataNode;
  48 import org.onap.cps.spi.model.DataNodeBuilder;
  49 import org.onap.cps.spi.utils.CpsValidator;
  50 import org.onap.cps.utils.ContentType;
  51 import org.onap.cps.utils.YangUtils;
  52 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  53 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  54 import org.springframework.stereotype.Service;
  55
  56 @Service
  57 @Slf4j
  58 @RequiredArgsConstructor
  59 public class CpsDataServiceImpl implements CpsDataService {
  60
  61     private static final String ROOT_NODE_XPATH = "/";
  62     private static final long DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS = 300L;
  63
  64     private final CpsDataPersistenceService cpsDataPersistenceService;
  65     private final CpsAdminService cpsAdminService;
  66     private final YangTextSchemaSourceSetCache yangTextSchemaSourceSetCache;
  67     private final NotificationService notificationService;
  68     private final CpsValidator cpsValidator;
  69
  70     @Override
  71     public void saveData(final String dataspaceName, final String anchorName, final String nodeData,
  72         final OffsetDateTime observedTimestamp) {
  73         saveData(dataspaceName, anchorName, nodeData, observedTimestamp, ContentType.JSON);
  74     }
  75
  76     @Override
  77     public void saveData(final String dataspaceName, final String anchorName, final String nodeData,
  78                          final OffsetDateTime observedTimestamp, final ContentType contentType) {
  79         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
  80         final Collection<DataNode> dataNodes =
  81                 buildDataNodes(dataspaceName, anchorName, ROOT_NODE_XPATH, nodeData, contentType);
  82         cpsDataPersistenceService.storeDataNodes(dataspaceName, anchorName, dataNodes);
  83         processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, CREATE, observedTimestamp);
  84     }
  85
  86     @Override
  87     public void saveData(final String dataspaceName, final String anchorName, final String parentNodeXpath,
  88                          final String nodeData, final OffsetDateTime observedTimestamp) {
  89         saveData(dataspaceName, anchorName, parentNodeXpath, nodeData, observedTimestamp, ContentType.JSON);
  90     }
  91
  92     @Override
  93     public void saveData(final String dataspaceName, final String anchorName, final String parentNodeXpath,
  94                          final String nodeData, final OffsetDateTime observedTimestamp,
  95                          final ContentType contentType) {
  96         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
  97         final Collection<DataNode> dataNodes =
  98                 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, nodeData, contentType);
  99         cpsDataPersistenceService.addChildDataNodes(dataspaceName, anchorName, parentNodeXpath, dataNodes);
 100         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, CREATE, observedTimestamp);
 101     }
 102
 103     @Override
 104     public void saveListElements(final String dataspaceName, final String anchorName,
 105         final String parentNodeXpath, final String jsonData, final OffsetDateTime observedTimestamp) {
 106         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 107         final Collection<DataNode> listElementDataNodeCollection =
 108             buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData, ContentType.JSON);
 109         cpsDataPersistenceService.addListElements(dataspaceName, anchorName, parentNodeXpath,
 110             listElementDataNodeCollection);
 111         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 112     }
 113
 114     @Override
 115     public void saveListElementsBatch(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 116             final Collection<String> jsonDataList, final OffsetDateTime observedTimestamp) {
 117         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 118         final Collection<Collection<DataNode>> listElementDataNodeCollections =
 119                 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonDataList, ContentType.JSON);
 120         cpsDataPersistenceService.addMultipleLists(dataspaceName, anchorName, parentNodeXpath,
 121                 listElementDataNodeCollections);
 122         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 123     }
 124
 125     @Override
 126     public DataNode getDataNode(final String dataspaceName, final String anchorName, final String xpath,
 127         final FetchDescendantsOption fetchDescendantsOption) {
 128         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 129         return cpsDataPersistenceService.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption);
 130     }
 131
 132     @Override
 133     public void updateNodeLeaves(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 134         final String jsonData, final OffsetDateTime observedTimestamp) {
 135         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 136         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData, ContentType.JSON);
 137         cpsDataPersistenceService
 138             .updateDataLeaves(dataspaceName, anchorName, dataNode.getXpath(), dataNode.getLeaves());
 139         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 140     }
 141
 142     @Override
 143     public void updateNodeLeavesAndExistingDescendantLeaves(final String dataspaceName, final String anchorName,
 144         final String parentNodeXpath,
 145         final String dataNodeUpdatesAsJson,
 146         final OffsetDateTime observedTimestamp) {
 147         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 148         final Collection<DataNode> dataNodeUpdates =
 149             buildDataNodes(dataspaceName, anchorName,
 150                 parentNodeXpath, dataNodeUpdatesAsJson, ContentType.JSON);
 151         for (final DataNode dataNodeUpdate : dataNodeUpdates) {
 152             processDataNodeUpdate(dataspaceName, anchorName, dataNodeUpdate);
 153         }
 154         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 155     }
 156
 157     @Override
 158     public String startSession() {
 159         return cpsDataPersistenceService.startSession();
 160     }
 161
 162     @Override
 163     public void closeSession(final String sessionId) {
 164         cpsDataPersistenceService.closeSession(sessionId);
 165     }
 166
 167     @Override
 168     public void lockAnchor(final String sessionID, final String dataspaceName, final String anchorName) {
 169         lockAnchor(sessionID, dataspaceName, anchorName, DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS);
 170     }
 171
 172     @Override
 173     public void lockAnchor(final String sessionID, final String dataspaceName,
 174                            final String anchorName, final Long timeoutInMilliseconds) {
 175         cpsDataPersistenceService.lockAnchor(sessionID, dataspaceName, anchorName, timeoutInMilliseconds);
 176     }
 177
 178     @Override
 179     public void updateDataNodeAndDescendants(final String dataspaceName, final String anchorName,
 180                                              final String parentNodeXpath, final String jsonData,
 181                                              final OffsetDateTime observedTimestamp) {
 182         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 183         final Collection<DataNode> dataNodes =
 184                 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData, ContentType.JSON);
 185         final ArrayList<DataNode> nodes = new ArrayList<>(dataNodes);
 186         cpsDataPersistenceService.updateDataNodesAndDescendants(dataspaceName, anchorName, nodes);
 187         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 188     }
 189
 190     @Override
 191     public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
 192                                               final Map<String, String> nodesJsonData,
 193                                               final OffsetDateTime observedTimestamp) {
 194         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 195         final List<DataNode> dataNodes = buildDataNodes(dataspaceName, anchorName, nodesJsonData);
 196         cpsDataPersistenceService.updateDataNodesAndDescendants(dataspaceName, anchorName, dataNodes);
 197         nodesJsonData.keySet().forEach(nodeXpath ->
 198             processDataUpdatedEventAsync(dataspaceName, anchorName, nodeXpath,
 199                 UPDATE, observedTimestamp));
 200     }
 201
 202     @Override
 203     public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 204             final String jsonData, final OffsetDateTime observedTimestamp) {
 205         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 206         final Collection<DataNode> newListElements =
 207                 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData, ContentType.JSON);
 208         replaceListContent(dataspaceName, anchorName, parentNodeXpath, newListElements, observedTimestamp);
 209     }
 210
 211     @Override
 212     public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 213             final Collection<DataNode> dataNodes, final OffsetDateTime observedTimestamp) {
 214         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 215         cpsDataPersistenceService.replaceListContent(dataspaceName, anchorName, parentNodeXpath, dataNodes);
 216         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 217     }
 218
 219     @Override
 220     public void deleteDataNode(final String dataspaceName, final String anchorName, final String dataNodeXpath,
 221                                final OffsetDateTime observedTimestamp) {
 222         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 223         cpsDataPersistenceService.deleteDataNode(dataspaceName, anchorName, dataNodeXpath);
 224         processDataUpdatedEventAsync(dataspaceName, anchorName, dataNodeXpath, DELETE, observedTimestamp);
 225     }
 226
 227     @Override
 228     public void deleteDataNodes(final String dataspaceName, final String anchorName,
 229         final OffsetDateTime observedTimestamp) {
 230         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 231         processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, DELETE, observedTimestamp);
 232         cpsDataPersistenceService.deleteDataNodes(dataspaceName, anchorName);
 233     }
 234
 235     @Override
 236     public void deleteListOrListElement(final String dataspaceName, final String anchorName, final String listNodeXpath,
 237         final OffsetDateTime observedTimestamp) {
 238         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 239         cpsDataPersistenceService.deleteListDataNode(dataspaceName, anchorName, listNodeXpath);
 240         processDataUpdatedEventAsync(dataspaceName, anchorName, listNodeXpath, DELETE, observedTimestamp);
 241     }
 242
 243     private DataNode buildDataNode(final String dataspaceName, final String anchorName,
 244                                    final String parentNodeXpath, final String nodeData,
 245                                    final ContentType contentType) {
 246
 247         final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 248         final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
 249
 250         if (ROOT_NODE_XPATH.equals(parentNodeXpath)) {
 251             final ContainerNode containerNode = YangUtils.parseData(contentType, nodeData, schemaContext);
 252             return new DataNodeBuilder().withContainerNode(containerNode).build();
 253         }
 254
 255         final ContainerNode containerNode = YangUtils.parseData(contentType, nodeData, schemaContext, parentNodeXpath);
 256
 257         return new DataNodeBuilder()
 258                 .withParentNodeXpath(parentNodeXpath)
 259                 .withContainerNode(containerNode)
 260                 .build();
 261     }
 262
 263     private List<DataNode> buildDataNodes(final String dataspaceName, final String anchorName,
 264                                           final Map<String, String> nodesJsonData) {
 265         return nodesJsonData.entrySet().stream().map(nodeJsonData ->
 266             buildDataNode(dataspaceName, anchorName, nodeJsonData.getKey(),
 267                 nodeJsonData.getValue(), ContentType.JSON)).collect(Collectors.toList());
 268     }
 269
 270     private Collection<DataNode> buildDataNodes(final String dataspaceName,
 271                                                 final String anchorName,
 272                                                 final String parentNodeXpath,
 273                                                 final String nodeData,
 274                                                 final ContentType contentType) {
 275
 276         final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 277         final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
 278         if (ROOT_NODE_XPATH.equals(parentNodeXpath)) {
 279             final ContainerNode containerNode = YangUtils.parseData(contentType, nodeData, schemaContext);
 280             final Collection<DataNode> dataNodes = new DataNodeBuilder()
 281                     .withContainerNode(containerNode)
 282                     .buildCollection();
 283             if (dataNodes.isEmpty()) {
 284                 throw new DataValidationException("Invalid data.", "No data nodes provided");
 285             }
 286             return dataNodes;
 287         }
 288         final ContainerNode containerNode = YangUtils.parseData(contentType, nodeData, schemaContext, parentNodeXpath);
 289         final Collection<DataNode> dataNodes = new DataNodeBuilder()
 290             .withParentNodeXpath(parentNodeXpath)
 291             .withContainerNode(containerNode)
 292             .buildCollection();
 293         if (dataNodes.isEmpty()) {
 294             throw new DataValidationException("Invalid data.", "No data nodes provided");
 295         }
 296         return dataNodes;
 297
 298     }
 299
 300     private Collection<Collection<DataNode>> buildDataNodes(final String dataspaceName, final String anchorName,
 301             final String parentNodeXpath, final Collection<String> nodeDataList, final ContentType contentType) {
 302         return nodeDataList.stream()
 303                 .map(nodeData -> buildDataNodes(dataspaceName, anchorName, parentNodeXpath, nodeData, contentType))
 304                 .collect(Collectors.toList());
 305     }
 306
 307     private void processDataUpdatedEventAsync(final String dataspaceName, final String anchorName, final String xpath,
 308             final Operation operation, final OffsetDateTime observedTimestamp) {
 309         try {
 310             notificationService.processDataUpdatedEvent(dataspaceName, anchorName, xpath, operation, observedTimestamp);
 311         } catch (final Exception exception) {
 312             //If async message can't be queued for notification service, the initial request should not failed.
 313             log.error("Failed to send message to notification service", exception);
 314         }
 315     }
 316
 317     private SchemaContext getSchemaContext(final String dataspaceName, final String schemaSetName) {
 318         return yangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName).getSchemaContext();
 319     }
 320
 321     private void processDataNodeUpdate(final String dataspaceName, final String anchorName,
 322                                        final DataNode dataNodeUpdate) {
 323         if (dataNodeUpdate == null) {
 324             return;
 325         }
 326         cpsDataPersistenceService.updateDataLeaves(dataspaceName, anchorName, dataNodeUpdate.getXpath(),
 327             dataNodeUpdate.getLeaves());
 328         final Collection<DataNode> childDataNodeUpdates = dataNodeUpdate.getChildDataNodes();
 329         for (final DataNode childDataNodeUpdate : childDataNodeUpdates) {
 330             processDataNodeUpdate(dataspaceName, anchorName, childDataNodeUpdate);
 331         }
 332     }
 333
 334 }