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  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.spi;
  22
  23 import org.checkerframework.checker.nullness.qual.NonNull;
  24 import org.onap.cps.spi.model.DataNode;
  25
  26 /*
  27     Data Store interface that is responsible for handling yang data.
  28     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
  29     when adding methods.
  30  */
  31 public interface CpsDataPersistenceService {
  32
  33     /**
  34      * Store a datanode.
  35      *
  36      * @param dataspaceName dataspace name
  37      * @param anchorName    anchor name
  38      * @param dataNode      data node
  39      */
  40     void storeDataNode(@NonNull String dataspaceName, @NonNull String anchorName,
  41         @NonNull DataNode dataNode);
  42
  43     /**
  44      * Add a child to a Fragment.
  45      *
  46      * @param dataspaceName dataspace name
  47      * @param anchorName    anchor name
  48      * @param parentXpath   parent xpath
  49      * @param dataNode      dataNode
  50      */
  51     void addChildDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentXpath,
  52         @NonNull DataNode dataNode);
  53 }