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.DataValidationException;
  26 import org.onap.cps.spi.model.DataNode;
  27
  28 /*
  29  * Datastore interface for handling CPS data.
  30  */
  31 public interface CpsDataService {
  32
  33     /**
  34      * Persists data for the given anchor and dataspace.
  35      *
  36      * @param dataspaceName dataspace name
  37      * @param anchorName    anchor name
  38      * @param jsonData      json data
  39      * @throws DataValidationException when json data is invalid
  40      */
  41     void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String jsonData);
  42
  43     /**
  44      * Retrieves datanode by XPath for given dataspace and anchor.
  45      *
  46      * @param dataspaceName          dataspace name
  47      * @param anchorName             anchor name
  48      * @param xpath                  xpath
  49      * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
  50      *                               (recursively) as well
  51      * @return data node object
  52      */
  53     DataNode getDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
  54         @NonNull FetchDescendantsOption fetchDescendantsOption);
  55
  56     /**
  57      * Updates data node for given dataspace and anchor using xpath to parent node.
  58      *
  59      * @param dataspaceName   dataspace name
  60      * @param anchorName      anchor name
  61      * @param parentNodeXpath xpath to parent node
  62      * @param jsonData        json data
  63      */
  64     void updateNodeLeaves(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
  65         @NonNull String jsonData);
  66
  67     /**
  68      * Replaces existing data node content including descendants.
  69      *
  70      * @param dataspaceName   dataspace name
  71      * @param anchorName      anchor name
  72      * @param parentNodeXpath xpath to parent node
  73      * @param jsonData        json data
  74      */
  75     void replaceNodeTree(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
  76         @NonNull String jsonData);
  77 }