2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020-2022 Nordix Foundation.
4 * Modifications Copyright (C) 2021 Pantheon.tech
5 * Modifications Copyright (C) 2022 Bell Canada
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.cps.spi;
25 import java.util.Collection;
26 import java.util.List;
28 import org.onap.cps.spi.model.DataNode;
31 Data Store interface that is responsible for handling yang data.
32 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
35 public interface CpsDataPersistenceService {
40 * @param dataspaceName dataspace name
41 * @param anchorName anchor name
42 * @param dataNode data node
44 void storeDataNode(String dataspaceName, String anchorName, 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(String dataspaceName, String anchorName, String parentXpath, DataNode dataNode);
57 * Adds list child elements to a Fragment.
59 * @param dataspaceName dataspace name
60 * @param anchorName anchor name
61 * @param parentNodeXpath parent node xpath
62 * @param listElementsCollection collection of data nodes representing list elements
65 void addListElements(String dataspaceName, String anchorName, String parentNodeXpath,
66 Collection<DataNode> listElementsCollection);
69 * Adds list child elements to a Fragment.
71 * @param dataspaceName dataspace name
72 * @param anchorName anchor name
73 * @param parentNodeXpath parent node xpath
74 * @param listElementsCollections collections of data nodes representing list elements
76 void addListElementsBatch(String dataspaceName, String anchorName, String parentNodeXpath,
77 Collection<Collection<DataNode>> listElementsCollections);
80 * Retrieves datanode by XPath for given dataspace and anchor.
82 * @param dataspaceName dataspace name
83 * @param anchorName anchor name
85 * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
86 * (recursively) as well
87 * @return data node object
89 DataNode getDataNode(String dataspaceName, String anchorName, String xpath,
90 FetchDescendantsOption fetchDescendantsOption);
94 * Updates leaves for existing data node.
96 * @param dataspaceName dataspace name
97 * @param anchorName anchor name
99 * @param leaves the leaves as a map where key is a leaf name and a value is a leaf value
101 void updateDataLeaves(String dataspaceName, String anchorName, String xpath, Map<String, Object> leaves);
104 * Replaces an existing data node's content including descendants.
106 * @param dataspaceName dataspace name
107 * @param anchorName anchor name
108 * @param dataNode data node
110 void updateDataNodeAndDescendants(String dataspaceName, String anchorName, DataNode dataNode);
113 * Replaces multiple existing data nodes' content including descendants in a batch operation.
115 * @param dataspaceName dataspace name
116 * @param anchorName anchor name
117 * @param dataNodes data nodes
119 void updateDataNodesAndDescendants(String dataspaceName, String anchorName, final List<DataNode> dataNodes);
122 * Replaces list content by removing all existing elements and inserting the given new elements
123 * under given parent, anchor and dataspace.
125 * @param dataspaceName dataspace name
126 * @param anchorName anchor name
127 * @param parentNodeXpath parent node xpath
128 * @param newListElements collection of data nodes representing the new list content
130 void replaceListContent(String dataspaceName, String anchorName,
131 String parentNodeXpath, Collection<DataNode> newListElements);
134 * Deletes any dataNode, yang container or yang list or yang list element.
136 * @param dataspaceName dataspace name
137 * @param anchorName anchor name
138 * @param targetXpath xpath to list or list element (include [@key=value] to delete a single list element)
140 void deleteDataNode(String dataspaceName, String anchorName, String targetXpath);
143 * Deletes all dataNodes in a given anchor.
145 * @param dataspaceName dataspace name
146 * @param anchorName anchor name
148 void deleteDataNodes(String dataspaceName, String anchorName);
151 * Deletes existing a single list element or the whole list.
153 * @param dataspaceName dataspace name
154 * @param anchorName anchor name
155 * @param targetXpath xpath to list or list element (include [@key=value] to delete a single list element)
157 void deleteListDataNode(String dataspaceName, String anchorName, String targetXpath);
160 * Get a datanode by cps path.
162 * @param dataspaceName dataspace name
163 * @param anchorName anchor name
164 * @param cpsPath cps path
165 * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
166 * included in the output
167 * @return the data nodes found i.e. 0 or more data nodes
169 List<DataNode> queryDataNodes(String dataspaceName, String anchorName,
170 String cpsPath, FetchDescendantsOption fetchDescendantsOption);
173 * Starts a session which allows use of locks and batch interaction with the persistence service.
175 * @return Session ID string
177 String startSession();
182 * @param sessionId session ID
184 void closeSession(String sessionId);
188 * To release locks(s), the session holding the lock(s) must be closed.
190 * @param sessionID session ID
191 * @param dataspaceName dataspace name
192 * @param anchorName anchor name
193 * @param timeoutInMilliseconds lock attempt timeout in milliseconds
195 void lockAnchor(String sessionID, String dataspaceName, String anchorName, Long timeoutInMilliseconds);