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