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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.spi;
24 import java.util.Collection;
26 import org.checkerframework.checker.nullness.qual.NonNull;
27 import org.onap.cps.spi.model.DataNode;
30 Data Store interface that is responsible for handling yang data.
31 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
34 public interface CpsDataPersistenceService {
39 * @param dataspaceName dataspace name
40 * @param anchorName anchor name
41 * @param dataNode data node
43 void storeDataNode(@NonNull String dataspaceName, @NonNull String anchorName,
44 @NonNull DataNode dataNode);
47 * Add a child to a Fragment.
49 * @param dataspaceName dataspace name
50 * @param anchorName anchor name
51 * @param parentXpath parent xpath
52 * @param dataNode dataNode
54 void addChildDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentXpath,
55 @NonNull DataNode dataNode);
58 * Retrieves datanode by XPath for given dataspace and anchor.
60 * @param dataspaceName dataspace name
61 * @param anchorName anchor name
63 * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
64 * (recursively) as well
65 * @return data node object
67 DataNode getDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
68 @NonNull FetchDescendantsOption fetchDescendantsOption);
72 * Updates leaves for existing data node.
74 * @param dataspaceName dataspace name
75 * @param anchorName anchor name
77 * @param leaves the leaves as a map where key is a leaf name and a value is a leaf value
79 void updateDataLeaves(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
80 @NonNull Map<String, Object> leaves);
83 * Replaces existing data node content including descendants.
85 * @param dataspaceName dataspace name
86 * @param anchorName anchor name
87 * @param dataNode data node
89 void replaceDataNodeTree(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull DataNode dataNode);
92 * Get a datanode by cps path.
94 * @param dataspaceName dataspace name
95 * @param anchorName anchor name
96 * @param cpsPath cps path
97 * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
98 * included in the output
99 * @return the data nodes found i.e. 0 or more data nodes
101 Collection<DataNode> queryDataNodes(@NonNull String dataspaceName, @NonNull String anchorName,
102 @NonNull String cpsPath, @NonNull FetchDescendantsOption fetchDescendantsOption);