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.RequiredArgsConstructor;
  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.spi.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 @RequiredArgsConstructor
  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     private final CpsValidator cpsValidator;
  65
  66     @Override
  67     public void saveData(final String dataspaceName, final String anchorName, final String jsonData,
  68         final OffsetDateTime observedTimestamp) {
  69         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
  70         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, ROOT_NODE_XPATH, jsonData);
  71         cpsDataPersistenceService.storeDataNode(dataspaceName, anchorName, dataNode);
  72         processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, CREATE, observedTimestamp);
  73     }
  74
  75     @Override
  76     public void saveData(final String dataspaceName, final String anchorName, final String parentNodeXpath,
  77         final String jsonData, final OffsetDateTime observedTimestamp) {
  78         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
  79         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
  80         cpsDataPersistenceService.addChildDataNode(dataspaceName, anchorName, parentNodeXpath, dataNode);
  81         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, CREATE, observedTimestamp);
  82     }
  83
  84     @Override
  85     public void saveListElements(final String dataspaceName, final String anchorName,
  86         final String parentNodeXpath, final String jsonData, final OffsetDateTime observedTimestamp) {
  87         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
  88         final Collection<DataNode> listElementDataNodeCollection =
  89             buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
  90         cpsDataPersistenceService.addListElements(dataspaceName, anchorName, parentNodeXpath,
  91             listElementDataNodeCollection);
  92         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
  93     }
  94
  95     @Override
  96     public void saveListElementsBatch(final String dataspaceName, final String anchorName, final String parentNodeXpath,
  97             final Collection<String> jsonDataList, final OffsetDateTime observedTimestamp) {
  98         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
  99         final Collection<Collection<DataNode>> listElementDataNodeCollections =
 100                 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonDataList);
 101         cpsDataPersistenceService.addMultipleLists(dataspaceName, anchorName, parentNodeXpath,
 102                 listElementDataNodeCollections);
 103         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 104     }
 105
 106     @Override
 107     public DataNode getDataNode(final String dataspaceName, final String anchorName, final String xpath,
 108         final FetchDescendantsOption fetchDescendantsOption) {
 109         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 110         return cpsDataPersistenceService.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption);
 111     }
 112
 113     @Override
 114     public void updateNodeLeaves(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 115         final String jsonData, final OffsetDateTime observedTimestamp) {
 116         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 117         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
 118         cpsDataPersistenceService
 119             .updateDataLeaves(dataspaceName, anchorName, dataNode.getXpath(), dataNode.getLeaves());
 120         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 121     }
 122
 123     @Override
 124     public void updateNodeLeavesAndExistingDescendantLeaves(final String dataspaceName, final String anchorName,
 125         final String parentNodeXpath,
 126         final String dataNodeUpdatesAsJson,
 127         final OffsetDateTime observedTimestamp) {
 128         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 129         final Collection<DataNode> dataNodeUpdates =
 130             buildDataNodes(dataspaceName, anchorName,
 131                 parentNodeXpath, dataNodeUpdatesAsJson);
 132         for (final DataNode dataNodeUpdate : dataNodeUpdates) {
 133             processDataNodeUpdate(dataspaceName, anchorName, dataNodeUpdate);
 134         }
 135         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 136     }
 137
 138     @Override
 139     public String startSession() {
 140         return cpsDataPersistenceService.startSession();
 141     }
 142
 143     @Override
 144     public void closeSession(final String sessionId) {
 145         cpsDataPersistenceService.closeSession(sessionId);
 146     }
 147
 148     @Override
 149     public void lockAnchor(final String sessionID, final String dataspaceName, final String anchorName) {
 150         lockAnchor(sessionID, dataspaceName, anchorName, DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS);
 151     }
 152
 153     @Override
 154     public void lockAnchor(final String sessionID, final String dataspaceName,
 155                            final String anchorName, final Long timeoutInMilliseconds) {
 156         cpsDataPersistenceService.lockAnchor(sessionID, dataspaceName, anchorName, timeoutInMilliseconds);
 157     }
 158
 159     @Override
 160     public void updateDataNodeAndDescendants(final String dataspaceName, final String anchorName,
 161                                              final String parentNodeXpath, final String jsonData,
 162                                              final OffsetDateTime observedTimestamp) {
 163         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 164         final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
 165         cpsDataPersistenceService.updateDataNodeAndDescendants(dataspaceName, anchorName, dataNode);
 166         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 167     }
 168
 169     @Override
 170     public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
 171                                               final Map<String, String> nodesJsonData,
 172                                               final OffsetDateTime observedTimestamp) {
 173         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 174         final List<DataNode> dataNodes = buildDataNodes(dataspaceName, anchorName, nodesJsonData);
 175         cpsDataPersistenceService.updateDataNodesAndDescendants(dataspaceName, anchorName, dataNodes);
 176         nodesJsonData.keySet().forEach(nodeXpath ->
 177             processDataUpdatedEventAsync(dataspaceName, anchorName, nodeXpath,
 178                 UPDATE, observedTimestamp));
 179     }
 180
 181     @Override
 182     public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 183             final String jsonData, final OffsetDateTime observedTimestamp) {
 184         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 185         final Collection<DataNode> newListElements =
 186                 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
 187         replaceListContent(dataspaceName, anchorName, parentNodeXpath, newListElements, observedTimestamp);
 188     }
 189
 190     @Override
 191     public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 192             final Collection<DataNode> dataNodes, final OffsetDateTime observedTimestamp) {
 193         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 194         cpsDataPersistenceService.replaceListContent(dataspaceName, anchorName, parentNodeXpath, dataNodes);
 195         processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
 196     }
 197
 198     @Override
 199     public void deleteDataNode(final String dataspaceName, final String anchorName, final String dataNodeXpath,
 200                                final OffsetDateTime observedTimestamp) {
 201         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 202         cpsDataPersistenceService.deleteDataNode(dataspaceName, anchorName, dataNodeXpath);
 203         processDataUpdatedEventAsync(dataspaceName, anchorName, dataNodeXpath, DELETE, observedTimestamp);
 204     }
 205
 206     @Override
 207     public void deleteDataNodes(final String dataspaceName, final String anchorName,
 208         final OffsetDateTime observedTimestamp) {
 209         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 210         processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, DELETE, observedTimestamp);
 211         cpsDataPersistenceService.deleteDataNodes(dataspaceName, anchorName);
 212     }
 213
 214     @Override
 215     public void deleteListOrListElement(final String dataspaceName, final String anchorName, final String listNodeXpath,
 216         final OffsetDateTime observedTimestamp) {
 217         cpsValidator.validateNameCharacters(dataspaceName, anchorName);
 218         cpsDataPersistenceService.deleteListDataNode(dataspaceName, anchorName, listNodeXpath);
 219         processDataUpdatedEventAsync(dataspaceName, anchorName, listNodeXpath, DELETE, observedTimestamp);
 220     }
 221
 222     private DataNode buildDataNode(final String dataspaceName, final String anchorName,
 223                                    final String parentNodeXpath, final String jsonData) {
 224
 225         final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 226         final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
 227
 228         if (ROOT_NODE_XPATH.equals(parentNodeXpath)) {
 229             final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext);
 230             return new DataNodeBuilder().withNormalizedNodeTree(normalizedNode).build();
 231         }
 232
 233         final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath);
 234         return new DataNodeBuilder()
 235             .withParentNodeXpath(parentNodeXpath)
 236             .withNormalizedNodeTree(normalizedNode)
 237             .build();
 238     }
 239
 240     private List<DataNode> buildDataNodes(final String dataspaceName, final String anchorName,
 241                                           final Map<String, String> nodesJsonData) {
 242         return nodesJsonData.entrySet().stream().map(nodeJsonData ->
 243             buildDataNode(dataspaceName, anchorName, nodeJsonData.getKey(),
 244                 nodeJsonData.getValue())).collect(Collectors.toList());
 245     }
 246
 247     private Collection<DataNode> buildDataNodes(final String dataspaceName,
 248                                                 final String anchorName,
 249                                                 final String parentNodeXpath,
 250                                                 final String jsonData) {
 251
 252         final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 253         final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
 254
 255         final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath);
 256         final Collection<DataNode> dataNodes = new DataNodeBuilder()
 257             .withParentNodeXpath(parentNodeXpath)
 258             .withNormalizedNodeTree(normalizedNode)
 259             .buildCollection();
 260         if (dataNodes.isEmpty()) {
 261             throw new DataValidationException("Invalid data.", "No data nodes provided");
 262         }
 263         return dataNodes;
 264
 265     }
 266
 267     private Collection<Collection<DataNode>> buildDataNodes(final String dataspaceName, final String anchorName,
 268             final String parentNodeXpath, final Collection<String> jsonDataList) {
 269         return jsonDataList.stream()
 270                 .map(jsonData -> buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData))
 271                 .collect(Collectors.toList());
 272     }
 273
 274     private void processDataUpdatedEventAsync(final String dataspaceName, final String anchorName, final String xpath,
 275             final Operation operation, final OffsetDateTime observedTimestamp) {
 276         try {
 277             notificationService.processDataUpdatedEvent(dataspaceName, anchorName, xpath, operation, observedTimestamp);
 278         } catch (final Exception exception) {
 279             //If async message can't be queued for notification service, the initial request should not failed.
 280             log.error("Failed to send message to notification service", exception);
 281         }
 282     }
 283
 284     private SchemaContext getSchemaContext(final String dataspaceName, final String schemaSetName) {
 285         return yangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName).getSchemaContext();
 286     }
 287
 288     private void processDataNodeUpdate(final String dataspaceName, final String anchorName,
 289                                        final DataNode dataNodeUpdate) {
 290         if (dataNodeUpdate == null) {
 291             return;
 292         }
 293         cpsDataPersistenceService.updateDataLeaves(dataspaceName, anchorName, dataNodeUpdate.getXpath(),
 294             dataNodeUpdate.getLeaves());
 295         final Collection<DataNode> childDataNodeUpdates = dataNodeUpdate.getChildDataNodes();
 296         for (final DataNode childDataNodeUpdate : childDataNodeUpdates) {
 297             processDataNodeUpdate(dataspaceName, anchorName, childDataNodeUpdate);
 298         }
 299     }
 300
 301 }