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
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.api;
23 import org.checkerframework.checker.nullness.qual.NonNull;
24 import org.onap.cps.spi.FetchDescendantsOption;
25 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
26 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
27 import org.onap.cps.spi.exceptions.DataValidationException;
28 import org.onap.cps.spi.model.DataNode;
31 * Datastore interface for handling CPS data.
33 public interface CpsDataService {
36 * Persists data for the given anchor and dataspace.
38 * @param dataspaceName dataspace name
39 * @param anchorName anchor name
40 * @param jsonData json data
41 * @throws DataValidationException when json data is invalid
43 void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String jsonData);
46 * Persists child data fragment under existing data node for the given anchor and dataspace.
48 * @param dataspaceName dataspace name
49 * @param anchorName anchor name
50 * @param parentNodeXpath parent node xpath
51 * @param jsonData json data
52 * @throws DataValidationException when json data is invalid
53 * @throws DataNodeNotFoundException when parent node cannot be found by parent node xpath
54 * @throws AlreadyDefinedException when child data node with same xpath already exists
56 void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
57 @NonNull String jsonData);
60 * Persists child data fragment representing list-node (with one or more elements) under existing data node
61 * for the given anchor and dataspace.
63 * @param dataspaceName dataspace name
64 * @param anchorName anchor name
65 * @param parentNodeXpath parent node xpath
66 * @param jsonData json data representing list element
67 * @throws DataValidationException when json data is invalid (incl. list-node being empty)
68 * @throws DataNodeNotFoundException when parent node cannot be found by parent node xpath
69 * @throws AlreadyDefinedException when any of child data nodes is having xpath of already existing node
71 void saveListNodeData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
72 @NonNull String jsonData);
75 * Retrieves datanode by XPath for given dataspace and anchor.
77 * @param dataspaceName dataspace name
78 * @param anchorName anchor name
80 * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
81 * (recursively) as well
82 * @return data node object
84 DataNode getDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath,
85 @NonNull FetchDescendantsOption fetchDescendantsOption);
88 * Updates data node for given dataspace and anchor using xpath to parent node.
90 * @param dataspaceName dataspace name
91 * @param anchorName anchor name
92 * @param parentNodeXpath xpath to parent node
93 * @param jsonData json data
95 void updateNodeLeaves(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
96 @NonNull String jsonData);
99 * Replaces existing data node content including descendants.
101 * @param dataspaceName dataspace name
102 * @param anchorName anchor name
103 * @param parentNodeXpath xpath to parent node
104 * @param jsonData json data
106 void replaceNodeTree(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
107 @NonNull String jsonData);
110 * Replaces (if exists) child data fragment representing list-node (with one or more elements)
111 * under existing data node for the given anchor and dataspace.
113 * @param dataspaceName dataspace name
114 * @param anchorName anchor name
115 * @param parentNodeXpath parent node xpath
116 * @param jsonData json data representing list element
117 * @throws DataValidationException when json data is invalid (incl. list-node being empty)
118 * @throws DataNodeNotFoundException when parent node cannot be found by parent node xpath
120 void replaceListNodeData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
121 @NonNull String jsonData);