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
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 * Adds list child elements to a Fragment.
60 * @param dataspaceName dataspace name
61 * @param anchorName anchor name
62 * @param parentNodeXpath parent node xpath
63 * @param listElementsCollection collection of data nodes representing list elements
66 void addListElements(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
67 @NonNull Collection<DataNode> listElementsCollection);
70 * Retrieves datanode by XPath for given dataspace and anchor.
72 * @param dataspaceName dataspace name
73 * @param anchorName anchor name
75 * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
76 * (recursively) as well
77 * @return data node object
79 DataNode getDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
80 @NonNull FetchDescendantsOption fetchDescendantsOption);
84 * Updates leaves for existing data node.
86 * @param dataspaceName dataspace name
87 * @param anchorName anchor name
89 * @param leaves the leaves as a map where key is a leaf name and a value is a leaf value
91 void updateDataLeaves(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
92 @NonNull Map<String, Object> leaves);
95 * Replaces existing data node content including descendants.
97 * @param dataspaceName dataspace name
98 * @param anchorName anchor name
99 * @param dataNode data node
101 void replaceDataNodeTree(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull DataNode dataNode);
104 * Replaces list content by removing all existing elements and inserting the given new elements
105 * under given parent, anchor and dataspace.
107 * @param dataspaceName dataspace name
108 * @param anchorName anchor name
109 * @param parentNodeXpath parent node xpath
110 * @param newListElements collection of data nodes representing the new list content
112 void replaceListContent(@NonNull String dataspaceName, @NonNull String anchorName,
113 @NonNull String parentNodeXpath, @NonNull Collection<DataNode> newListElements);
116 * Deletes any dataNode, yang container or yang list or yang list element.
118 * @param dataspaceName dataspace name
119 * @param anchorName anchor name
120 * @param targetXpath xpath to list or list element (include [@key=value] to delete a single list element)
122 void deleteDataNode(@NonNull String dataspaceName, @NonNull String anchorName,
123 @NonNull String targetXpath);
126 * Deletes existing a single list element or the whole list.
128 * @param dataspaceName dataspace name
129 * @param anchorName anchor name
130 * @param targetXpath xpath to list or list element (include [@key=value] to delete a single list element)
132 void deleteListDataNode(@NonNull String dataspaceName, @NonNull String anchorName,
133 @NonNull String targetXpath);
136 * Get a datanode by cps path.
138 * @param dataspaceName dataspace name
139 * @param anchorName anchor name
140 * @param cpsPath cps path
141 * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
142 * included in the output
143 * @return the data nodes found i.e. 0 or more data nodes
145 Collection<DataNode> queryDataNodes(@NonNull String dataspaceName, @NonNull String anchorName,
146 @NonNull String cpsPath, @NonNull FetchDescendantsOption fetchDescendantsOption);