2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020-2022 Bell Canada.
4 * Modifications Copyright (C) 2021 Pantheon.tech
5 * Modifications Copyright (C) 2021-2023 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 io.micrometer.core.annotation.Timed;
28 import java.time.OffsetDateTime;
29 import java.time.format.DateTimeFormatter;
30 import java.util.ArrayList;
31 import java.util.Collection;
32 import java.util.List;
34 import javax.validation.ValidationException;
35 import lombok.RequiredArgsConstructor;
36 import org.apache.commons.lang3.StringUtils;
37 import org.onap.cps.api.CpsDataService;
38 import org.onap.cps.rest.api.CpsDataApi;
39 import org.onap.cps.spi.FetchDescendantsOption;
40 import org.onap.cps.spi.model.DataNode;
41 import org.onap.cps.utils.ContentType;
42 import org.onap.cps.utils.DataMapUtils;
43 import org.onap.cps.utils.JsonObjectMapper;
44 import org.onap.cps.utils.PrefixResolver;
45 import org.springframework.http.HttpStatus;
46 import org.springframework.http.MediaType;
47 import org.springframework.http.ResponseEntity;
48 import org.springframework.web.bind.annotation.RequestHeader;
49 import org.springframework.web.bind.annotation.RequestMapping;
50 import org.springframework.web.bind.annotation.RestController;
53 @RequestMapping("${rest.api.cps-base-path}")
54 @RequiredArgsConstructor
55 public class DataRestController implements CpsDataApi {
57 private static final String ROOT_XPATH = "/";
58 private static final String ISO_TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
59 private static final DateTimeFormatter ISO_TIMESTAMP_FORMATTER = DateTimeFormatter.ofPattern(ISO_TIMESTAMP_FORMAT);
61 private final CpsDataService cpsDataService;
62 private final JsonObjectMapper jsonObjectMapper;
63 private final PrefixResolver prefixResolver;
66 public ResponseEntity<String> createNode(final String apiVersion,
67 final String dataspaceName, final String anchorName,
68 @RequestHeader(value = "Content-Type") final String contentTypeHeader,
69 final String nodeData, final String parentNodeXpath,
70 final String observedTimestamp) {
71 final ContentType contentType = contentTypeHeader.contains(MediaType.APPLICATION_XML_VALUE) ? ContentType.XML
73 if (isRootXpath(parentNodeXpath)) {
74 cpsDataService.saveData(dataspaceName, anchorName, nodeData,
75 toOffsetDateTime(observedTimestamp), contentType);
77 cpsDataService.saveData(dataspaceName, anchorName, parentNodeXpath,
78 nodeData, toOffsetDateTime(observedTimestamp), contentType);
80 return new ResponseEntity<>(HttpStatus.CREATED);
84 public ResponseEntity<Void> deleteDataNode(final String apiVersion,
85 final String dataspaceName, final String anchorName,
86 final String xpath, final String observedTimestamp) {
87 cpsDataService.deleteDataNode(dataspaceName, anchorName, xpath,
88 toOffsetDateTime(observedTimestamp));
89 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
93 public ResponseEntity<String> addListElements(final String apiVersion, final String dataspaceName,
94 final String anchorName, final String parentNodeXpath,
95 final Object jsonData, final String observedTimestamp) {
96 cpsDataService.saveListElements(dataspaceName, anchorName, parentNodeXpath,
97 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
98 return new ResponseEntity<>(HttpStatus.CREATED);
102 @Timed(value = "cps.data.controller.datanode.get.v1",
103 description = "Time taken to get data node")
104 public ResponseEntity<Object> getNodeByDataspaceAndAnchor(final String dataspaceName,
105 final String anchorName, final String xpath, final Boolean includeDescendants) {
106 final FetchDescendantsOption fetchDescendantsOption = Boolean.TRUE.equals(includeDescendants)
107 ? FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS : FetchDescendantsOption.OMIT_DESCENDANTS;
108 final DataNode dataNode = cpsDataService.getDataNodes(dataspaceName, anchorName, xpath,
109 fetchDescendantsOption).iterator().next();
110 final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, dataNode.getXpath());
111 return new ResponseEntity<>(DataMapUtils.toDataMapWithIdentifier(dataNode, prefix), HttpStatus.OK);
115 @Timed(value = "cps.data.controller.datanode.get.v2",
116 description = "Time taken to get data node")
117 public ResponseEntity<Object> getNodeByDataspaceAndAnchorV2(final String dataspaceName, final String anchorName,
119 final String fetchDescendantsOptionAsString) {
120 final FetchDescendantsOption fetchDescendantsOption =
121 FetchDescendantsOption.getFetchDescendantsOption(fetchDescendantsOptionAsString);
122 final Collection<DataNode> dataNodes = cpsDataService.getDataNodes(dataspaceName, anchorName, xpath,
123 fetchDescendantsOption);
124 final List<Map<String, Object>> dataMaps = new ArrayList<>(dataNodes.size());
125 for (final DataNode dataNode: dataNodes) {
126 final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, dataNode.getXpath());
127 final Map<String, Object> dataMap = DataMapUtils.toDataMapWithIdentifier(dataNode, prefix);
128 dataMaps.add(dataMap);
130 return new ResponseEntity<>(jsonObjectMapper.asJsonString(dataMaps), HttpStatus.OK);
134 public ResponseEntity<Object> updateNodeLeaves(final String apiVersion, final String dataspaceName,
135 final String anchorName, final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
136 cpsDataService.updateNodeLeaves(dataspaceName, anchorName, parentNodeXpath,
137 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
138 return new ResponseEntity<>(HttpStatus.OK);
142 public ResponseEntity<Object> replaceNode(final String apiVersion,
143 final String dataspaceName, final String anchorName,
144 final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
146 .updateDataNodeAndDescendants(dataspaceName, anchorName, parentNodeXpath,
147 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
148 return new ResponseEntity<>(HttpStatus.OK);
152 public ResponseEntity<Object> replaceListContent(final String apiVersion,
153 final String dataspaceName, final String anchorName,
154 final String parentNodeXpath, final Object jsonData,
155 final String observedTimestamp) {
156 cpsDataService.replaceListContent(dataspaceName, anchorName, parentNodeXpath,
157 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
158 return new ResponseEntity<>(HttpStatus.OK);
162 public ResponseEntity<Void> deleteListOrListElement(final String dataspaceName, final String anchorName,
163 final String listElementXpath, final String observedTimestamp) {
165 .deleteListOrListElement(dataspaceName, anchorName, listElementXpath, toOffsetDateTime(observedTimestamp));
166 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
169 private static boolean isRootXpath(final String xpath) {
170 return ROOT_XPATH.equals(xpath);
173 private static OffsetDateTime toOffsetDateTime(final String datetTimestamp) {
175 return StringUtils.isEmpty(datetTimestamp)
176 ? null : OffsetDateTime.parse(datetTimestamp, ISO_TIMESTAMP_FORMATTER);
177 } catch (final Exception exception) {
178 throw new ValidationException(
179 String.format("observed-timestamp must be in '%s' format", ISO_TIMESTAMP_FORMAT));