cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation. All rights reserved.
   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  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.spi;
  23
  24 import org.checkerframework.checker.nullness.qual.NonNull;
  25 import org.onap.cps.spi.model.DataNode;
  26
  27 /*
  28     Data Store interface that is responsible for handling yang data.
  29     Please follow guidelines in https://gerrit.nordix.org/#/c/onap/ccsdk/features/+/6698/19/cps/interface-proposal/src/main/java/cps/javadoc/spi/DataStoreService.java
  30     when adding methods.
  31  */
  32 public interface CpsDataPersistenceService {
  33
  34     /**
  35      * Store a datanode.
  36      *
  37      * @param dataspaceName dataspace name
  38      * @param anchorName    anchor name
  39      * @param dataNode      data node
  40      */
  41     void storeDataNode(@NonNull String dataspaceName, @NonNull String anchorName,
  42         @NonNull DataNode dataNode);
  43
  44     /**
  45      * Add a child to a Fragment.
  46      *
  47      * @param dataspaceName dataspace name
  48      * @param anchorName    anchor name
  49      * @param parentXpath   parent xpath
  50      * @param dataNode      dataNode
  51      */
  52     void addChildDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentXpath,
  53         @NonNull DataNode dataNode);
  54
  55     /**
  56      * Retrieves datanode by XPath for given dataspace and anchor.
  57      *
  58      * @param dataspaceName          dataspace name
  59      * @param anchorName             anchor name
  60      * @param xpath                  xpath
  61      * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
  62      *                               (recursively) as well
  63      * @return data node object
  64      */
  65     DataNode getDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
  66         @NonNull FetchDescendantsOption fetchDescendantsOption);
  67 }