2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2022 Nordix Foundation
4 * Modifications Copyright (C) 2020-2022 Bell Canada.
5 * Modifications Copyright (C) 2021 Pantheon.tech
6 * Modifications Copyright (C) 2022 TechMahindra Ltd.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.cps.api.impl;
26 import static org.onap.cps.notification.Operation.CREATE;
27 import static org.onap.cps.notification.Operation.DELETE;
28 import static org.onap.cps.notification.Operation.UPDATE;
30 import java.time.OffsetDateTime;
31 import java.util.ArrayList;
32 import java.util.Collection;
33 import java.util.List;
35 import java.util.stream.Collectors;
36 import lombok.RequiredArgsConstructor;
37 import lombok.extern.slf4j.Slf4j;
38 import org.onap.cps.api.CpsAdminService;
39 import org.onap.cps.api.CpsDataService;
40 import org.onap.cps.notification.NotificationService;
41 import org.onap.cps.notification.Operation;
42 import org.onap.cps.spi.CpsDataPersistenceService;
43 import org.onap.cps.spi.FetchDescendantsOption;
44 import org.onap.cps.spi.exceptions.DataValidationException;
45 import org.onap.cps.spi.model.Anchor;
46 import org.onap.cps.spi.model.DataNode;
47 import org.onap.cps.spi.model.DataNodeBuilder;
48 import org.onap.cps.spi.utils.CpsValidator;
49 import org.onap.cps.utils.YangUtils;
50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
51 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
52 import org.springframework.stereotype.Service;
56 @RequiredArgsConstructor
57 public class CpsDataServiceImpl implements CpsDataService {
59 private static final String ROOT_NODE_XPATH = "/";
60 private static final long DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS = 300L;
62 private final CpsDataPersistenceService cpsDataPersistenceService;
63 private final CpsAdminService cpsAdminService;
64 private final YangTextSchemaSourceSetCache yangTextSchemaSourceSetCache;
65 private final NotificationService notificationService;
66 private final CpsValidator cpsValidator;
69 public void saveData(final String dataspaceName, final String anchorName, final String jsonData,
70 final OffsetDateTime observedTimestamp) {
71 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
72 final Collection<DataNode> dataNodes =
73 buildDataNodes(dataspaceName, anchorName, ROOT_NODE_XPATH, jsonData);
74 cpsDataPersistenceService.storeDataNodes(dataspaceName, anchorName, dataNodes);
75 processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, CREATE, observedTimestamp);
79 public void saveData(final String dataspaceName, final String anchorName, final String parentNodeXpath,
80 final String jsonData, final OffsetDateTime observedTimestamp) {
81 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
82 final Collection<DataNode> dataNodes =
83 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
84 cpsDataPersistenceService.addChildDataNodes(dataspaceName, anchorName, parentNodeXpath, dataNodes);
85 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, CREATE, observedTimestamp);
89 public void saveListElements(final String dataspaceName, final String anchorName,
90 final String parentNodeXpath, final String jsonData, final OffsetDateTime observedTimestamp) {
91 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
92 final Collection<DataNode> listElementDataNodeCollection =
93 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
94 cpsDataPersistenceService.addListElements(dataspaceName, anchorName, parentNodeXpath,
95 listElementDataNodeCollection);
96 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
100 public void saveListElementsBatch(final String dataspaceName, final String anchorName, final String parentNodeXpath,
101 final Collection<String> jsonDataList, final OffsetDateTime observedTimestamp) {
102 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
103 final Collection<Collection<DataNode>> listElementDataNodeCollections =
104 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonDataList);
105 cpsDataPersistenceService.addMultipleLists(dataspaceName, anchorName, parentNodeXpath,
106 listElementDataNodeCollections);
107 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
111 public DataNode getDataNode(final String dataspaceName, final String anchorName, final String xpath,
112 final FetchDescendantsOption fetchDescendantsOption) {
113 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
114 return cpsDataPersistenceService.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption);
118 public void updateNodeLeaves(final String dataspaceName, final String anchorName, final String parentNodeXpath,
119 final String jsonData, final OffsetDateTime observedTimestamp) {
120 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
121 final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
122 cpsDataPersistenceService
123 .updateDataLeaves(dataspaceName, anchorName, dataNode.getXpath(), dataNode.getLeaves());
124 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
128 public void updateNodeLeavesAndExistingDescendantLeaves(final String dataspaceName, final String anchorName,
129 final String parentNodeXpath,
130 final String dataNodeUpdatesAsJson,
131 final OffsetDateTime observedTimestamp) {
132 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
133 final Collection<DataNode> dataNodeUpdates =
134 buildDataNodes(dataspaceName, anchorName,
135 parentNodeXpath, dataNodeUpdatesAsJson);
136 for (final DataNode dataNodeUpdate : dataNodeUpdates) {
137 processDataNodeUpdate(dataspaceName, anchorName, dataNodeUpdate);
139 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
143 public String startSession() {
144 return cpsDataPersistenceService.startSession();
148 public void closeSession(final String sessionId) {
149 cpsDataPersistenceService.closeSession(sessionId);
153 public void lockAnchor(final String sessionID, final String dataspaceName, final String anchorName) {
154 lockAnchor(sessionID, dataspaceName, anchorName, DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS);
158 public void lockAnchor(final String sessionID, final String dataspaceName,
159 final String anchorName, final Long timeoutInMilliseconds) {
160 cpsDataPersistenceService.lockAnchor(sessionID, dataspaceName, anchorName, timeoutInMilliseconds);
164 public void updateDataNodeAndDescendants(final String dataspaceName, final String anchorName,
165 final String parentNodeXpath, final String jsonData,
166 final OffsetDateTime observedTimestamp) {
167 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
168 final Collection<DataNode> dataNodes =
169 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
170 final ArrayList<DataNode> nodes = new ArrayList<>(dataNodes);
171 cpsDataPersistenceService.updateDataNodesAndDescendants(dataspaceName, anchorName, nodes);
172 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
176 public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
177 final Map<String, String> nodesJsonData,
178 final OffsetDateTime observedTimestamp) {
179 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
180 final List<DataNode> dataNodes = buildDataNodes(dataspaceName, anchorName, nodesJsonData);
181 cpsDataPersistenceService.updateDataNodesAndDescendants(dataspaceName, anchorName, dataNodes);
182 nodesJsonData.keySet().forEach(nodeXpath ->
183 processDataUpdatedEventAsync(dataspaceName, anchorName, nodeXpath,
184 UPDATE, observedTimestamp));
188 public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
189 final String jsonData, final OffsetDateTime observedTimestamp) {
190 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
191 final Collection<DataNode> newListElements =
192 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
193 replaceListContent(dataspaceName, anchorName, parentNodeXpath, newListElements, observedTimestamp);
197 public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
198 final Collection<DataNode> dataNodes, final OffsetDateTime observedTimestamp) {
199 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
200 cpsDataPersistenceService.replaceListContent(dataspaceName, anchorName, parentNodeXpath, dataNodes);
201 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
205 public void deleteDataNode(final String dataspaceName, final String anchorName, final String dataNodeXpath,
206 final OffsetDateTime observedTimestamp) {
207 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
208 cpsDataPersistenceService.deleteDataNode(dataspaceName, anchorName, dataNodeXpath);
209 processDataUpdatedEventAsync(dataspaceName, anchorName, dataNodeXpath, DELETE, observedTimestamp);
213 public void deleteDataNodes(final String dataspaceName, final String anchorName,
214 final OffsetDateTime observedTimestamp) {
215 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
216 processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, DELETE, observedTimestamp);
217 cpsDataPersistenceService.deleteDataNodes(dataspaceName, anchorName);
221 public void deleteListOrListElement(final String dataspaceName, final String anchorName, final String listNodeXpath,
222 final OffsetDateTime observedTimestamp) {
223 cpsValidator.validateNameCharacters(dataspaceName, anchorName);
224 cpsDataPersistenceService.deleteListDataNode(dataspaceName, anchorName, listNodeXpath);
225 processDataUpdatedEventAsync(dataspaceName, anchorName, listNodeXpath, DELETE, observedTimestamp);
228 private DataNode buildDataNode(final String dataspaceName, final String anchorName,
229 final String parentNodeXpath, final String jsonData) {
231 final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
232 final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
234 if (ROOT_NODE_XPATH.equals(parentNodeXpath)) {
235 final ContainerNode containerNode = YangUtils.parseJsonData(jsonData, schemaContext);
236 return new DataNodeBuilder().withContainerNode(containerNode).build();
239 final ContainerNode containerNode = YangUtils
240 .parseJsonData(jsonData, schemaContext, parentNodeXpath);
241 return new DataNodeBuilder()
242 .withParentNodeXpath(parentNodeXpath)
243 .withContainerNode(containerNode)
247 private List<DataNode> buildDataNodes(final String dataspaceName, final String anchorName,
248 final Map<String, String> nodesJsonData) {
249 return nodesJsonData.entrySet().stream().map(nodeJsonData ->
250 buildDataNode(dataspaceName, anchorName, nodeJsonData.getKey(),
251 nodeJsonData.getValue())).collect(Collectors.toList());
254 private Collection<DataNode> buildDataNodes(final String dataspaceName,
255 final String anchorName,
256 final String parentNodeXpath,
257 final String jsonData) {
259 final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
260 final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
261 if (ROOT_NODE_XPATH.equals(parentNodeXpath)) {
262 final ContainerNode containerNode = YangUtils.parseJsonData(jsonData, schemaContext);
263 final Collection<DataNode> dataNodes = new DataNodeBuilder()
264 .withContainerNode(containerNode)
266 if (dataNodes.isEmpty()) {
267 throw new DataValidationException("Invalid data.", "No data nodes provided");
271 final ContainerNode containerNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath);
272 final Collection<DataNode> dataNodes = new DataNodeBuilder()
273 .withParentNodeXpath(parentNodeXpath)
274 .withContainerNode(containerNode)
276 if (dataNodes.isEmpty()) {
277 throw new DataValidationException("Invalid data.", "No data nodes provided");
283 private Collection<Collection<DataNode>> buildDataNodes(final String dataspaceName, final String anchorName,
284 final String parentNodeXpath, final Collection<String> jsonDataList) {
285 return jsonDataList.stream()
286 .map(jsonData -> buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData))
287 .collect(Collectors.toList());
290 private void processDataUpdatedEventAsync(final String dataspaceName, final String anchorName, final String xpath,
291 final Operation operation, final OffsetDateTime observedTimestamp) {
293 notificationService.processDataUpdatedEvent(dataspaceName, anchorName, xpath, operation, observedTimestamp);
294 } catch (final Exception exception) {
295 //If async message can't be queued for notification service, the initial request should not failed.
296 log.error("Failed to send message to notification service", exception);
300 private SchemaContext getSchemaContext(final String dataspaceName, final String schemaSetName) {
301 return yangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName).getSchemaContext();
304 private void processDataNodeUpdate(final String dataspaceName, final String anchorName,
305 final DataNode dataNodeUpdate) {
306 if (dataNodeUpdate == null) {
309 cpsDataPersistenceService.updateDataLeaves(dataspaceName, anchorName, dataNodeUpdate.getXpath(),
310 dataNodeUpdate.getLeaves());
311 final Collection<DataNode> childDataNodeUpdates = dataNodeUpdate.getChildDataNodes();
312 for (final DataNode childDataNodeUpdate : childDataNodeUpdates) {
313 processDataNodeUpdate(dataspaceName, anchorName, childDataNodeUpdate);