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