1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2020-2023 Nordix Foundation.
* Modifications Copyright (C) 2021 Pantheon.tech
* Modifications Copyright (C) 2022 Bell Canada
* Modifications Copyright (C) 2022 TechMahindra Ltd.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.cps.spi;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.onap.cps.spi.model.DataNode;
/*
Data Store interface that is responsible for handling yang data.
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
when adding methods.
*/
public interface CpsDataPersistenceService {
/**
* Store a datanode.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param dataNode data node
* @deprecated Please use {@link #storeDataNodes(String, String, Collection)} as it supports multiple data nodes.
*/
@Deprecated
void storeDataNode(String dataspaceName, String anchorName, DataNode dataNode);
/**
* Store multiple datanodes at once.
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param dataNodes data nodes
*/
void storeDataNodes(String dataspaceName, String anchorName, Collection<DataNode> dataNodes);
/**
* Add a child to a Fragment.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentXpath parent xpath
* @param dataNode dataNode
*/
void addChildDataNode(String dataspaceName, String anchorName, String parentXpath, DataNode dataNode);
/**
* Add multiple children to a Fragment.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentXpath parent xpath
* @param dataNodes collection of dataNodes
*/
void addChildDataNodes(String dataspaceName, String anchorName, String parentXpath, Collection<DataNode> dataNodes);
/**
* Adds list child elements to a Fragment.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param listElementsCollection collection of data nodes representing list elements
*/
void addListElements(String dataspaceName, String anchorName, String parentNodeXpath,
Collection<DataNode> listElementsCollection);
/**
* Add multiple lists of data nodes to a parent node at the same time.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param newLists collections of lists of data nodes representing list elements
*/
void addMultipleLists(String dataspaceName, String anchorName, String parentNodeXpath,
Collection<Collection<DataNode>> newLists);
/**
* Retrieves datanode by XPath for given dataspace and anchor.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param xpath xpath
* @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
* (recursively) as well
* @return data node object
*/
DataNode getDataNode(String dataspaceName, String anchorName, String xpath,
FetchDescendantsOption fetchDescendantsOption);
/**
* Retrieves datanode by XPath for given dataspace and anchor.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param xpaths collection of xpaths
* @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
* (recursively) as well
* @return data node object
*/
Collection<DataNode> getDataNodes(String dataspaceName, String anchorName, Collection<String> xpaths,
FetchDescendantsOption fetchDescendantsOption);
/**
* Updates leaves for existing data node.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param xpath xpath
* @param leaves the leaves as a map where key is a leaf name and a value is a leaf value
*/
void updateDataLeaves(String dataspaceName, String anchorName, String xpath, Map<String, Serializable> leaves);
/**
* Replaces an existing data node's content including descendants.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param dataNode data node
*/
void updateDataNodeAndDescendants(String dataspaceName, String anchorName, DataNode dataNode);
/**
* Replaces multiple existing data nodes' content including descendants in a batch operation.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param dataNodes data nodes
*/
void updateDataNodesAndDescendants(String dataspaceName, String anchorName, final List<DataNode> dataNodes);
/**
* Replaces list content by removing all existing elements and inserting the given new elements
* under given parent, anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param newListElements collection of data nodes representing the new list content
*/
void replaceListContent(String dataspaceName, String anchorName,
String parentNodeXpath, Collection<DataNode> newListElements);
/**
* Deletes any dataNode, yang container or yang list or yang list element.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param targetXpath xpath to list or list element (include [@key=value] to delete a single list element)
*/
void deleteDataNode(String dataspaceName, String anchorName, String targetXpath);
/**
* Deletes multiple dataNode, yang container or yang list or yang list element.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param targetXpaths xpaths of nodes to delete
*/
void deleteDataNodes(String dataspaceName, String anchorName, Collection<String> targetXpaths);
/**
* Deletes all dataNodes in a given anchor.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
*/
void deleteDataNodes(String dataspaceName, String anchorName);
/**
* Deletes a single existing list element or the whole list.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param targetXpath xpath to list or list element (include [@key=value] to delete a single list element)
*/
void deleteListDataNode(String dataspaceName, String anchorName, String targetXpath);
/**
* Get a datanode by cps path.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param cpsPath cps path
* @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
* included in the output
* @return the data nodes found i.e. 0 or more data nodes
*/
List<DataNode> queryDataNodes(String dataspaceName, String anchorName,
String cpsPath, FetchDescendantsOption fetchDescendantsOption);
/**
* Starts a session which allows use of locks and batch interaction with the persistence service.
*
* @return Session ID string
*/
String startSession();
/**
* Close session.
*
* @param sessionId session ID
*/
void closeSession(String sessionId);
/**
* Lock anchor.
* To release locks(s), the session holding the lock(s) must be closed.
*
* @param sessionID session ID
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param timeoutInMilliseconds lock attempt timeout in milliseconds
*/
void lockAnchor(String sessionID, String dataspaceName, String anchorName, Long timeoutInMilliseconds);
}
|