2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020-2022 Bell Canada.
4 * Modifications Copyright (C) 2021 Pantheon.tech
5 * Modifications Copyright (C) 2021-2022 Nordix Foundation
6 * Modifications Copyright (C) 2022-2023 TechMahindra Ltd.
7 * Modifications Copyright (C) 2022 Deutsche Telekom AG
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * SPDX-License-Identifier: Apache-2.0
22 * ============LICENSE_END=========================================================
25 package org.onap.cps.rest.controller;
27 import java.time.OffsetDateTime;
28 import java.time.format.DateTimeFormatter;
29 import java.util.ArrayList;
30 import java.util.Collection;
31 import java.util.List;
33 import javax.validation.ValidationException;
34 import lombok.RequiredArgsConstructor;
35 import org.apache.commons.lang3.StringUtils;
36 import org.onap.cps.api.CpsDataService;
37 import org.onap.cps.rest.api.CpsDataApi;
38 import org.onap.cps.spi.FetchDescendantsOption;
39 import org.onap.cps.spi.model.DataNode;
40 import org.onap.cps.utils.ContentType;
41 import org.onap.cps.utils.DataMapUtils;
42 import org.onap.cps.utils.JsonObjectMapper;
43 import org.onap.cps.utils.PrefixResolver;
44 import org.springframework.http.HttpStatus;
45 import org.springframework.http.MediaType;
46 import org.springframework.http.ResponseEntity;
47 import org.springframework.web.bind.annotation.RequestHeader;
48 import org.springframework.web.bind.annotation.RequestMapping;
49 import org.springframework.web.bind.annotation.RestController;
52 @RequestMapping("${rest.api.cps-base-path}")
53 @RequiredArgsConstructor
54 public class DataRestController implements CpsDataApi {
56 private static final String ROOT_XPATH = "/";
57 private static final String ISO_TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
58 private static final DateTimeFormatter ISO_TIMESTAMP_FORMATTER = DateTimeFormatter.ofPattern(ISO_TIMESTAMP_FORMAT);
60 private final CpsDataService cpsDataService;
61 private final JsonObjectMapper jsonObjectMapper;
62 private final PrefixResolver prefixResolver;
65 public ResponseEntity<String> createNode(@RequestHeader(value = "Content-Type") final String contentTypeHeader,
66 final String apiVersion,
67 final String dataspaceName, final String anchorName,
68 final String nodeData, final String parentNodeXpath,
69 final String observedTimestamp) {
70 final ContentType contentType = contentTypeHeader.contains(MediaType.APPLICATION_XML_VALUE) ? ContentType.XML
72 if (isRootXpath(parentNodeXpath)) {
73 cpsDataService.saveData(dataspaceName, anchorName, nodeData,
74 toOffsetDateTime(observedTimestamp), contentType);
76 cpsDataService.saveData(dataspaceName, anchorName, parentNodeXpath,
77 nodeData, toOffsetDateTime(observedTimestamp), contentType);
79 return new ResponseEntity<>(HttpStatus.CREATED);
83 public ResponseEntity<Void> deleteDataNode(final String apiVersion,
84 final String dataspaceName, final String anchorName,
85 final String xpath, final String observedTimestamp) {
86 cpsDataService.deleteDataNode(dataspaceName, anchorName, xpath,
87 toOffsetDateTime(observedTimestamp));
88 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
92 public ResponseEntity<String> addListElements(final String parentNodeXpath, final String apiVersion,
93 final String dataspaceName, final String anchorName, final Object jsonData, final String observedTimestamp) {
94 cpsDataService.saveListElements(dataspaceName, anchorName, parentNodeXpath,
95 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
96 return new ResponseEntity<>(HttpStatus.CREATED);
100 public ResponseEntity<Object> getNodeByDataspaceAndAnchor(final String dataspaceName,
101 final String anchorName, final String xpath, final Boolean includeDescendants) {
102 final FetchDescendantsOption fetchDescendantsOption = Boolean.TRUE.equals(includeDescendants)
103 ? FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS : FetchDescendantsOption.OMIT_DESCENDANTS;
104 final DataNode dataNode = cpsDataService.getDataNodes(dataspaceName, anchorName, xpath,
105 fetchDescendantsOption).iterator().next();
106 final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, dataNode.getXpath());
107 return new ResponseEntity<>(DataMapUtils.toDataMapWithIdentifier(dataNode, prefix), HttpStatus.OK);
111 public ResponseEntity<Object> getNodeByDataspaceAndAnchorV2(final String dataspaceName, final String anchorName,
113 final String fetchDescendantsOptionAsString) {
114 final FetchDescendantsOption fetchDescendantsOption =
115 FetchDescendantsOption.getFetchDescendantsOption(fetchDescendantsOptionAsString);
116 final Collection<DataNode> dataNodes = cpsDataService.getDataNodes(dataspaceName, anchorName, xpath,
117 fetchDescendantsOption);
118 final List<Map<String, Object>> dataMaps = new ArrayList<>(dataNodes.size());
119 for (final DataNode dataNode: dataNodes) {
120 final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, dataNode.getXpath());
121 final Map<String, Object> dataMap = DataMapUtils.toDataMapWithIdentifier(dataNode, prefix);
122 dataMaps.add(dataMap);
124 return new ResponseEntity<>(jsonObjectMapper.asJsonString(dataMaps), HttpStatus.OK);
128 public ResponseEntity<Object> updateNodeLeaves(final String apiVersion, final String dataspaceName,
129 final String anchorName, final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
130 cpsDataService.updateNodeLeaves(dataspaceName, anchorName, parentNodeXpath,
131 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
132 return new ResponseEntity<>(HttpStatus.OK);
136 public ResponseEntity<Object> replaceNode(final String apiVersion,
137 final String dataspaceName, final String anchorName,
138 final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
140 .updateDataNodeAndDescendants(dataspaceName, anchorName, parentNodeXpath,
141 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
142 return new ResponseEntity<>(HttpStatus.OK);
146 public ResponseEntity<Object> replaceListContent(final String parentNodeXpath,
147 final String apiVersion, final String dataspaceName, final String anchorName, final Object jsonData,
148 final String observedTimestamp) {
149 cpsDataService.replaceListContent(dataspaceName, anchorName, parentNodeXpath,
150 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
151 return new ResponseEntity<>(HttpStatus.OK);
155 public ResponseEntity<Void> deleteListOrListElement(final String dataspaceName, final String anchorName,
156 final String listElementXpath, final String observedTimestamp) {
158 .deleteListOrListElement(dataspaceName, anchorName, listElementXpath, toOffsetDateTime(observedTimestamp));
159 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
162 private static boolean isRootXpath(final String xpath) {
163 return ROOT_XPATH.equals(xpath);
166 private static OffsetDateTime toOffsetDateTime(final String datetTimestamp) {
168 return StringUtils.isEmpty(datetTimestamp)
169 ? null : OffsetDateTime.parse(datetTimestamp, ISO_TIMESTAMP_FORMATTER);
170 } catch (final Exception exception) {
171 throw new ValidationException(
172 String.format("observed-timestamp must be in '%s' format", ISO_TIMESTAMP_FORMAT));