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 java.util.Map;
  25 import org.checkerframework.checker.nullness.qual.NonNull;
  26 import org.onap.cps.spi.model.DataNode;
  27
  28 /*
  29     Data Store interface that is responsible for handling yang data.
  30     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
  31     when adding methods.
  32  */
  33 public interface CpsDataPersistenceService {
  34
  35     /**
  36      * Store a datanode.
  37      *
  38      * @param dataspaceName dataspace name
  39      * @param anchorName    anchor name
  40      * @param dataNode      data node
  41      */
  42     void storeDataNode(@NonNull String dataspaceName, @NonNull String anchorName,
  43         @NonNull DataNode dataNode);
  44
  45     /**
  46      * Add a child to a Fragment.
  47      *
  48      * @param dataspaceName dataspace name
  49      * @param anchorName    anchor name
  50      * @param parentXpath   parent xpath
  51      * @param dataNode      dataNode
  52      */
  53     void addChildDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentXpath,
  54         @NonNull DataNode dataNode);
  55
  56     /**
  57      * Retrieves datanode by XPath for given dataspace and anchor.
  58      *
  59      * @param dataspaceName          dataspace name
  60      * @param anchorName             anchor name
  61      * @param xpath                  xpath
  62      * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
  63      *                               (recursively) as well
  64      * @return data node object
  65      */
  66     DataNode getDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
  67         @NonNull FetchDescendantsOption fetchDescendantsOption);
  68
  69
  70     /**
  71      * Updates leaves for existing data node.
  72      *
  73      * @param dataspaceName dataspace name
  74      * @param anchorName    anchor name
  75      * @param xpath         xpath
  76      * @param leaves        the leaves as a map where key is a leaf name and a value is a leaf value
  77      */
  78     void updateDataLeaves(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
  79         @NonNull Map<String, Object> leaves);
  80
  81     /**
  82      * Replaces existing data node content including descendants.
  83      *
  84      * @param dataspaceName dataspace name
  85      * @param anchorName    anchor name
  86      * @param dataNode      data node
  87      */
  88     void replaceDataNodeTree(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull DataNode dataNode);
  89 }