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 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.cps.api.impl;
25 import static org.onap.cps.notification.Operation.CREATE;
26 import static org.onap.cps.notification.Operation.DELETE;
27 import static org.onap.cps.notification.Operation.UPDATE;
29 import java.time.OffsetDateTime;
30 import java.util.Collection;
31 import java.util.List;
33 import java.util.stream.Collectors;
34 import lombok.AllArgsConstructor;
35 import lombok.extern.slf4j.Slf4j;
36 import org.onap.cps.api.CpsAdminService;
37 import org.onap.cps.api.CpsDataService;
38 import org.onap.cps.notification.NotificationService;
39 import org.onap.cps.notification.Operation;
40 import org.onap.cps.spi.CpsDataPersistenceService;
41 import org.onap.cps.spi.FetchDescendantsOption;
42 import org.onap.cps.spi.exceptions.DataValidationException;
43 import org.onap.cps.spi.model.Anchor;
44 import org.onap.cps.spi.model.DataNode;
45 import org.onap.cps.spi.model.DataNodeBuilder;
46 import org.onap.cps.utils.CpsValidator;
47 import org.onap.cps.utils.YangUtils;
48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
50 import org.springframework.stereotype.Service;
55 public class CpsDataServiceImpl implements CpsDataService {
57 private static final String ROOT_NODE_XPATH = "/";
58 private static final long DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS = 300L;
60 private final CpsDataPersistenceService cpsDataPersistenceService;
61 private final CpsAdminService cpsAdminService;
62 private final YangTextSchemaSourceSetCache yangTextSchemaSourceSetCache;
63 private final NotificationService notificationService;
66 public void saveData(final String dataspaceName, final String anchorName, final String jsonData,
67 final OffsetDateTime observedTimestamp) {
68 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
69 final DataNode dataNode = buildDataNode(dataspaceName, anchorName, ROOT_NODE_XPATH, jsonData);
70 cpsDataPersistenceService.storeDataNode(dataspaceName, anchorName, dataNode);
71 processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, CREATE, observedTimestamp);
75 public void saveData(final String dataspaceName, final String anchorName, final String parentNodeXpath,
76 final String jsonData, final OffsetDateTime observedTimestamp) {
77 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
78 final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
79 cpsDataPersistenceService.addChildDataNode(dataspaceName, anchorName, parentNodeXpath, dataNode);
80 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, CREATE, observedTimestamp);
84 public void saveListElements(final String dataspaceName, final String anchorName,
85 final String parentNodeXpath, final String jsonData, final OffsetDateTime observedTimestamp) {
86 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
87 final Collection<DataNode> listElementDataNodeCollection =
88 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
89 cpsDataPersistenceService.addListElements(dataspaceName, anchorName, parentNodeXpath,
90 listElementDataNodeCollection);
91 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
95 public void saveListElementsBatch(final String dataspaceName, final String anchorName, final String parentNodeXpath,
96 final Collection<String> jsonDataList, final OffsetDateTime observedTimestamp) {
97 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
98 final Collection<Collection<DataNode>> listElementDataNodeCollections =
99 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonDataList);
100 cpsDataPersistenceService.addMultipleLists(dataspaceName, anchorName, parentNodeXpath,
101 listElementDataNodeCollections);
102 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
106 public DataNode getDataNode(final String dataspaceName, final String anchorName, final String xpath,
107 final FetchDescendantsOption fetchDescendantsOption) {
108 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
109 return cpsDataPersistenceService.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption);
113 public void updateNodeLeaves(final String dataspaceName, final String anchorName, final String parentNodeXpath,
114 final String jsonData, final OffsetDateTime observedTimestamp) {
115 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
116 final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
117 cpsDataPersistenceService
118 .updateDataLeaves(dataspaceName, anchorName, dataNode.getXpath(), dataNode.getLeaves());
119 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
123 public void updateNodeLeavesAndExistingDescendantLeaves(final String dataspaceName, final String anchorName,
124 final String parentNodeXpath,
125 final String dataNodeUpdatesAsJson,
126 final OffsetDateTime observedTimestamp) {
127 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
128 final Collection<DataNode> dataNodeUpdates =
129 buildDataNodes(dataspaceName, anchorName,
130 parentNodeXpath, dataNodeUpdatesAsJson);
131 for (final DataNode dataNodeUpdate : dataNodeUpdates) {
132 processDataNodeUpdate(dataspaceName, anchorName, dataNodeUpdate);
134 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
138 public String startSession() {
139 return cpsDataPersistenceService.startSession();
143 public void closeSession(final String sessionId) {
144 cpsDataPersistenceService.closeSession(sessionId);
148 public void lockAnchor(final String sessionID, final String dataspaceName, final String anchorName) {
149 lockAnchor(sessionID, dataspaceName, anchorName, DEFAULT_LOCK_TIMEOUT_IN_MILLISECONDS);
153 public void lockAnchor(final String sessionID, final String dataspaceName,
154 final String anchorName, final Long timeoutInMilliseconds) {
155 cpsDataPersistenceService.lockAnchor(sessionID, dataspaceName, anchorName, timeoutInMilliseconds);
159 public void updateDataNodeAndDescendants(final String dataspaceName, final String anchorName,
160 final String parentNodeXpath, final String jsonData,
161 final OffsetDateTime observedTimestamp) {
162 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
163 final DataNode dataNode = buildDataNode(dataspaceName, anchorName, parentNodeXpath, jsonData);
164 cpsDataPersistenceService.updateDataNodeAndDescendants(dataspaceName, anchorName, dataNode);
165 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
169 public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
170 final Map<String, String> nodesJsonData,
171 final OffsetDateTime observedTimestamp) {
172 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
173 final List<DataNode> dataNodes = buildDataNodes(dataspaceName, anchorName, nodesJsonData);
174 cpsDataPersistenceService.updateDataNodesAndDescendants(dataspaceName, anchorName, dataNodes);
175 nodesJsonData.keySet().forEach(nodeXpath ->
176 processDataUpdatedEventAsync(dataspaceName, anchorName, nodeXpath,
177 UPDATE, observedTimestamp));
181 public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
182 final String jsonData, final OffsetDateTime observedTimestamp) {
183 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
184 final Collection<DataNode> newListElements =
185 buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData);
186 replaceListContent(dataspaceName, anchorName, parentNodeXpath, newListElements, observedTimestamp);
190 public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
191 final Collection<DataNode> dataNodes, final OffsetDateTime observedTimestamp) {
192 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
193 cpsDataPersistenceService.replaceListContent(dataspaceName, anchorName, parentNodeXpath, dataNodes);
194 processDataUpdatedEventAsync(dataspaceName, anchorName, parentNodeXpath, UPDATE, observedTimestamp);
198 public void deleteDataNode(final String dataspaceName, final String anchorName, final String dataNodeXpath,
199 final OffsetDateTime observedTimestamp) {
200 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
201 cpsDataPersistenceService.deleteDataNode(dataspaceName, anchorName, dataNodeXpath);
202 processDataUpdatedEventAsync(dataspaceName, anchorName, dataNodeXpath, DELETE, observedTimestamp);
206 public void deleteDataNodes(final String dataspaceName, final String anchorName,
207 final OffsetDateTime observedTimestamp) {
208 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
209 processDataUpdatedEventAsync(dataspaceName, anchorName, ROOT_NODE_XPATH, DELETE, observedTimestamp);
210 cpsDataPersistenceService.deleteDataNodes(dataspaceName, anchorName);
214 public void deleteListOrListElement(final String dataspaceName, final String anchorName, final String listNodeXpath,
215 final OffsetDateTime observedTimestamp) {
216 CpsValidator.validateNameCharacters(dataspaceName, anchorName);
217 cpsDataPersistenceService.deleteListDataNode(dataspaceName, anchorName, listNodeXpath);
218 processDataUpdatedEventAsync(dataspaceName, anchorName, listNodeXpath, DELETE, observedTimestamp);
221 private DataNode buildDataNode(final String dataspaceName, final String anchorName,
222 final String parentNodeXpath, final String jsonData) {
224 final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
225 final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
227 if (ROOT_NODE_XPATH.equals(parentNodeXpath)) {
228 final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext);
229 return new DataNodeBuilder().withNormalizedNodeTree(normalizedNode).build();
232 final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath);
233 return new DataNodeBuilder()
234 .withParentNodeXpath(parentNodeXpath)
235 .withNormalizedNodeTree(normalizedNode)
239 private List<DataNode> buildDataNodes(final String dataspaceName, final String anchorName,
240 final Map<String, String> nodesJsonData) {
241 return nodesJsonData.entrySet().stream().map(nodeJsonData ->
242 buildDataNode(dataspaceName, anchorName, nodeJsonData.getKey(),
243 nodeJsonData.getValue())).collect(Collectors.toList());
246 private Collection<DataNode> buildDataNodes(final String dataspaceName,
247 final String anchorName,
248 final String parentNodeXpath,
249 final String jsonData) {
251 final Anchor anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
252 final SchemaContext schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName());
254 final NormalizedNode<?, ?> normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath);
255 final Collection<DataNode> dataNodes = new DataNodeBuilder()
256 .withParentNodeXpath(parentNodeXpath)
257 .withNormalizedNodeTree(normalizedNode)
259 if (dataNodes.isEmpty()) {
260 throw new DataValidationException("Invalid data.", "No data nodes provided");
266 private Collection<Collection<DataNode>> buildDataNodes(final String dataspaceName, final String anchorName,
267 final String parentNodeXpath, final Collection<String> jsonDataList) {
268 return jsonDataList.stream()
269 .map(jsonData -> buildDataNodes(dataspaceName, anchorName, parentNodeXpath, jsonData))
270 .collect(Collectors.toList());
273 private void processDataUpdatedEventAsync(final String dataspaceName, final String anchorName, final String xpath,
274 final Operation operation, final OffsetDateTime observedTimestamp) {
276 notificationService.processDataUpdatedEvent(dataspaceName, anchorName, xpath, operation, observedTimestamp);
277 } catch (final Exception exception) {
278 //If async message can't be queued for notification service, the initial request should not failed.
279 log.error("Failed to send message to notification service", exception);
283 private SchemaContext getSchemaContext(final String dataspaceName, final String schemaSetName) {
284 return yangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName).getSchemaContext();
287 private void processDataNodeUpdate(final String dataspaceName, final String anchorName,
288 final DataNode dataNodeUpdate) {
289 if (dataNodeUpdate == null) {
292 cpsDataPersistenceService.updateDataLeaves(dataspaceName, anchorName, dataNodeUpdate.getXpath(),
293 dataNodeUpdate.getLeaves());
294 final Collection<DataNode> childDataNodeUpdates = dataNodeUpdate.getChildDataNodes();
295 for (final DataNode childDataNodeUpdate : childDataNodeUpdates) {
296 processDataNodeUpdate(dataspaceName, anchorName, childDataNodeUpdate);