cps-service/src/main/java/org/onap/cps/api/CpsDataService.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  Modifications Copyright (C) 2021 Pantheon.tech
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.api;
  22
  23 import org.checkerframework.checker.nullness.qual.NonNull;
  24 import org.onap.cps.spi.FetchDescendantsOption;
  25 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
  26 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  27 import org.onap.cps.spi.exceptions.DataValidationException;
  28 import org.onap.cps.spi.model.DataNode;
  29
  30 /*
  31  * Datastore interface for handling CPS data.
  32  */
  33 public interface CpsDataService {
  34
  35     /**
  36      * Persists data for the given anchor and dataspace.
  37      *
  38      * @param dataspaceName dataspace name
  39      * @param anchorName    anchor name
  40      * @param jsonData      json data
  41      * @throws DataValidationException when json data is invalid
  42      */
  43     void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String jsonData);
  44
  45     /**
  46      * Persists child data fragment under existing data node for the given anchor and dataspace.
  47      *
  48      * @param dataspaceName   dataspace name
  49      * @param anchorName      anchor name
  50      * @param parentNodeXpath parent node xpath
  51      * @param jsonData        json data
  52      * @throws DataValidationException   when json data is invalid
  53      * @throws DataNodeNotFoundException when parent node cannot be found by parent node xpath
  54      * @throws AlreadyDefinedException   when child data node with same xpath already exists
  55      */
  56     void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
  57         @NonNull String jsonData);
  58
  59     /**
  60      * Persists child data fragment representing list-node (with one or more elements) under existing data node
  61      * for the given anchor and dataspace.
  62      *
  63      * @param dataspaceName   dataspace name
  64      * @param anchorName      anchor name
  65      * @param parentNodeXpath parent node xpath
  66      * @param jsonData        json data representing list element
  67      * @throws DataValidationException   when json data is invalid (incl. list-node being empty)
  68      * @throws DataNodeNotFoundException when parent node cannot be found by parent node xpath
  69      * @throws AlreadyDefinedException   when any of child data nodes is having xpath of already existing node
  70      */
  71     void saveListNodeData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
  72         @NonNull String jsonData);
  73
  74     /**
  75      * Retrieves datanode by XPath for given dataspace and anchor.
  76      *
  77      * @param dataspaceName          dataspace name
  78      * @param anchorName             anchor name
  79      * @param xpath                  xpath
  80      * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
  81      *                               (recursively) as well
  82      * @return data node object
  83      */
  84     DataNode getDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
  85         @NonNull FetchDescendantsOption fetchDescendantsOption);
  86
  87     /**
  88      * Updates data node for given dataspace and anchor using xpath to parent node.
  89      *
  90      * @param dataspaceName   dataspace name
  91      * @param anchorName      anchor name
  92      * @param parentNodeXpath xpath to parent node
  93      * @param jsonData        json data
  94      */
  95     void updateNodeLeaves(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
  96         @NonNull String jsonData);
  97
  98     /**
  99      * Replaces existing data node content including descendants.
 100      *
 101      * @param dataspaceName   dataspace name
 102      * @param anchorName      anchor name
 103      * @param parentNodeXpath xpath to parent node
 104      * @param jsonData        json data
 105      */
 106     void replaceNodeTree(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
 107         @NonNull String jsonData);
 108 }