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