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
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2020 Nordix Foundation.
* Modifications Copyright (C) 2021 Pantheon.tech
* ================================================================================
* 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.util.Collection;
import java.util.Map;
import org.checkerframework.checker.nullness.qual.NonNull;
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
*/
void storeDataNode(@NonNull String dataspaceName, @NonNull String anchorName,
@NonNull DataNode dataNode);
/**
* Add a child to a Fragment.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentXpath parent xpath
* @param dataNode dataNode
*/
void addChildDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentXpath,
@NonNull DataNode dataNode);
/**
* Adds list node child elements to a Fragment.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param dataNodes collection of data nodes representing list node elements
*/
void addListDataNodes(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
@NonNull Collection<DataNode> dataNodes);
/**
* 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(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
@NonNull 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(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
@NonNull Map<String, Object> leaves);
/**
* Replaces existing data node content including descendants.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param dataNode data node
*/
void replaceDataNodeTree(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull DataNode dataNode);
/**
* Replaces existing list data node content including descendants.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentNodeXpath parent node xpath
* @param dataNodes collection of data nodes representing list node elements
*/
void replaceListDataNodes(@NonNull String dataspaceName, @NonNull String anchorName,
@NonNull String parentNodeXpath, @NonNull Collection<DataNode> dataNodes);
/**
* Deletes existing list data node content including descendants.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param listNodeXpath list node xpath
*/
void deleteListDataNodes(@NonNull String dataspaceName, @NonNull String anchorName,
@NonNull String listNodeXpath);
/**
* 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
*/
Collection<DataNode> queryDataNodes(@NonNull String dataspaceName, @NonNull String anchorName,
@NonNull String cpsPath, @NonNull FetchDescendantsOption fetchDescendantsOption);
}
|
