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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2020-2023 Nordix Foundation
* Modifications Copyright (C) 2021 Pantheon.tech
* Modifications Copyright (C) 2021-2022 Bell Canada
* Modifications Copyright (C) 2022 Deutsche Telekom AG
* Modifications Copyright (C) 2023 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.api;
import java.time.OffsetDateTime;
import java.util.Collection;
import java.util.Map;
import org.onap.cps.spi.FetchDescendantsOption;
import org.onap.cps.spi.model.DataNode;
import org.onap.cps.utils.ContentType;
/*
* Datastore interface for handling CPS data.
*/
public interface CpsDataService {
/**
* Persists data for the given anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param nodeData node data
* @param observedTimestamp observedTimestamp
*/
void saveData(String dataspaceName, String anchorName, String nodeData, OffsetDateTime observedTimestamp);
/**
* Persists data for the given anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param nodeData node data
* @param observedTimestamp observedTimestamp
* @param contentType node data content type
*/
void saveData(String dataspaceName, String anchorName, String nodeData, OffsetDateTime observedTimestamp,
ContentType contentType);
/**
* Persists child data fragment under existing data node for the given anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param nodeData node data
* @param observedTimestamp observedTimestamp
*/
void saveData(String dataspaceName, String anchorName, String parentNodeXpath, String nodeData,
OffsetDateTime observedTimestamp);
/**
* Persists child data fragment under existing data node for the given anchor, dataspace and content type.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param nodeData node data
* @param observedTimestamp observedTimestamp
* @param contentType node data content type
*
*/
void saveData(String dataspaceName, String anchorName, String parentNodeXpath, String nodeData,
OffsetDateTime observedTimestamp, ContentType contentType);
/**
* Persists child data fragment representing one or more list elements under existing data node for the
* given anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param jsonData json data representing list element(s)
* @param observedTimestamp observedTimestamp
*/
void saveListElements(String dataspaceName, String anchorName, String parentNodeXpath, String jsonData,
OffsetDateTime observedTimestamp);
/**
* Persists child data fragment representing one or more list elements under existing data node for the
* given anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param jsonDataList collection of json data representing list element(s)
* @param observedTimestamp observedTimestamp
*/
void saveListElementsBatch(String dataspaceName, String anchorName, String parentNodeXpath,
Collection<String> jsonDataList, OffsetDateTime observedTimestamp);
/**
* Retrieves all the datanodes 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 collection of data node objects
*/
Collection<DataNode> getDataNodes(String dataspaceName, String anchorName, String xpath,
FetchDescendantsOption fetchDescendantsOption);
/**
* Retrieves all the datanodes for multiple XPaths 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 collection of data node objects
*/
Collection<DataNode> getDataNodesForMultipleXpaths(String dataspaceName, String anchorName,
Collection<String> xpaths,
FetchDescendantsOption fetchDescendantsOption);
/**
* Updates multiple data nodes for given dataspace and anchor using xpath to parent node.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath xpath to parent node
* @param jsonData json data
* @param observedTimestamp observedTimestamp
*/
void updateNodeLeaves(String dataspaceName, String anchorName, String parentNodeXpath, String jsonData,
OffsetDateTime observedTimestamp);
/**
* Replaces an existing data node's content including descendants.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath xpath to parent node
* @param jsonData json data
* @param observedTimestamp observedTimestamp
*/
void updateDataNodeAndDescendants(String dataspaceName, String anchorName, String parentNodeXpath, String jsonData,
OffsetDateTime observedTimestamp);
/**
* Replaces multiple existing data nodes' content including descendants in a batch operation.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param nodesJsonData map of xpath and node JSON data
* @param observedTimestamp observedTimestamp
*/
void updateDataNodesAndDescendants(String dataspaceName, String anchorName, Map<String, String> nodesJsonData,
OffsetDateTime observedTimestamp);
/**
* Replaces list content by removing all existing elements and inserting the given new elements as json
* under given parent, anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param jsonData json data representing the new list elements
* @param observedTimestamp observedTimestamp
*/
void replaceListContent(String dataspaceName, String anchorName, String parentNodeXpath, String jsonData,
OffsetDateTime observedTimestamp);
/**
* Replaces list content by removing all existing elements and inserting the given new elements as data nodes
* under given parent, anchor and dataspace.
*
* @param dataspaceName dataspace-name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param dataNodes datanodes representing the updated data
* @param observedTimestamp observedTimestamp
*/
void replaceListContent(String dataspaceName, String anchorName, String parentNodeXpath,
Collection<DataNode> dataNodes, OffsetDateTime observedTimestamp);
/**
* Deletes data node for given anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param dataNodeXpath data node xpath
* @param observedTimestamp observed timestamp
*/
void deleteDataNode(String dataspaceName, String anchorName, String dataNodeXpath,
OffsetDateTime observedTimestamp);
/**
* Deletes multiple data nodes for given anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param dataNodeXpaths data node xpaths
* @param observedTimestamp observed timestamp
*/
void deleteDataNodes(String dataspaceName, String anchorName, Collection<String> dataNodeXpaths,
OffsetDateTime observedTimestamp);
/**
* Deletes all data nodes for a given anchor in a dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param observedTimestamp observed timestamp
*/
void deleteDataNodes(String dataspaceName, String anchorName, OffsetDateTime observedTimestamp);
/**
* Deletes all data nodes for multiple anchors in a dataspace.
*
* @param dataspaceName dataspace name
* @param anchorNames anchor names
* @param observedTimestamp observed timestamp
*/
void deleteDataNodes(String dataspaceName, Collection<String> anchorNames, OffsetDateTime observedTimestamp);
/**
* Deletes a list or a list-element under given anchor and dataspace.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param listElementXpath list element xpath
* @param observedTimestamp observedTimestamp
*/
void deleteListOrListElement(String dataspaceName, String anchorName, String listElementXpath,
OffsetDateTime observedTimestamp);
/**
* Updates leaves of DataNode for given dataspace and anchor using xpath, along with the leaves of each Child Data
* Node which already exists. This method will throw an exception if data node update or any descendant update does
* not exist.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath xpath
* @param dataNodeUpdatesAsJson json data representing data node updates
* @param observedTimestamp observedTimestamp
*/
void updateNodeLeavesAndExistingDescendantLeaves(String dataspaceName, String anchorName, String parentNodeXpath,
String dataNodeUpdatesAsJson, OffsetDateTime observedTimestamp);
/**
* 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 with default timeout.
* 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
*/
void lockAnchor(String sessionID, String dataspaceName, String anchorName);
/**
* Lock anchor with custom timeout.
* 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);
}
|
