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) 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 javax.validation.ValidationException;
30 import lombok.RequiredArgsConstructor;
31 import org.apache.commons.lang3.StringUtils;
32 import org.onap.cps.api.CpsDataService;
33 import org.onap.cps.rest.api.CpsDataApi;
34 import org.onap.cps.spi.FetchDescendantsOption;
35 import org.onap.cps.spi.model.DataNode;
36 import org.onap.cps.utils.ContentType;
37 import org.onap.cps.utils.DataMapUtils;
38 import org.onap.cps.utils.JsonObjectMapper;
39 import org.onap.cps.utils.PrefixResolver;
40 import org.springframework.http.HttpStatus;
41 import org.springframework.http.MediaType;
42 import org.springframework.http.ResponseEntity;
43 import org.springframework.web.bind.annotation.RequestHeader;
44 import org.springframework.web.bind.annotation.RequestMapping;
45 import org.springframework.web.bind.annotation.RestController;
48 @RequestMapping("${rest.api.cps-base-path}")
49 @RequiredArgsConstructor
50 public class DataRestController implements CpsDataApi {
52 private static final String ROOT_XPATH = "/";
53 private static final String ISO_TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
54 private static final DateTimeFormatter ISO_TIMESTAMP_FORMATTER = DateTimeFormatter.ofPattern(ISO_TIMESTAMP_FORMAT);
56 private final CpsDataService cpsDataService;
57 private final JsonObjectMapper jsonObjectMapper;
58 private final PrefixResolver prefixResolver;
61 public ResponseEntity<String> createNode(@RequestHeader(value = "Content-Type") final String contentTypeHeader,
62 final String apiVersion,
63 final String dataspaceName, final String anchorName,
64 final String nodeData, final String parentNodeXpath,
65 final String observedTimestamp) {
66 final ContentType contentType = contentTypeHeader.contains(MediaType.APPLICATION_XML_VALUE) ? ContentType.XML
68 if (isRootXpath(parentNodeXpath)) {
69 cpsDataService.saveData(dataspaceName, anchorName, nodeData,
70 toOffsetDateTime(observedTimestamp), contentType);
72 cpsDataService.saveData(dataspaceName, anchorName, parentNodeXpath,
73 nodeData, toOffsetDateTime(observedTimestamp), contentType);
75 return new ResponseEntity<>(HttpStatus.CREATED);
79 public ResponseEntity<Void> deleteDataNode(final String apiVersion,
80 final String dataspaceName, final String anchorName,
81 final String xpath, final String observedTimestamp) {
82 cpsDataService.deleteDataNode(dataspaceName, anchorName, xpath,
83 toOffsetDateTime(observedTimestamp));
84 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
88 public ResponseEntity<String> addListElements(final String parentNodeXpath, final String apiVersion,
89 final String dataspaceName, final String anchorName, final Object jsonData, final String observedTimestamp) {
90 cpsDataService.saveListElements(dataspaceName, anchorName, parentNodeXpath,
91 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
92 return new ResponseEntity<>(HttpStatus.CREATED);
96 public ResponseEntity<Object> getNodeByDataspaceAndAnchor(final String dataspaceName,
97 final String anchorName, final String xpath, final Boolean includeDescendants) {
98 final FetchDescendantsOption fetchDescendantsOption = Boolean.TRUE.equals(includeDescendants)
99 ? FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS : FetchDescendantsOption.OMIT_DESCENDANTS;
100 final DataNode dataNode = cpsDataService.getDataNode(dataspaceName, anchorName, xpath,
101 fetchDescendantsOption);
102 final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, xpath);
103 return new ResponseEntity<>(DataMapUtils.toDataMapWithIdentifier(dataNode, prefix), HttpStatus.OK);
107 public ResponseEntity<Object> getNodeByDataspaceAndAnchorV2(final String dataspaceName, final String anchorName,
108 final String xpath, final String fetchDescendantsOptionAsString) {
109 final FetchDescendantsOption fetchDescendantsOption =
110 FetchDescendantsOption.getFetchDescendantsOption(fetchDescendantsOptionAsString);
111 final DataNode dataNode = cpsDataService.getDataNode(dataspaceName, anchorName, xpath,
112 fetchDescendantsOption);
113 final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, xpath);
114 return new ResponseEntity<>(DataMapUtils.toDataMapWithIdentifier(dataNode, prefix), HttpStatus.OK);
118 public ResponseEntity<Object> updateNodeLeaves(final String apiVersion, final String dataspaceName,
119 final String anchorName, final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
120 cpsDataService.updateNodeLeaves(dataspaceName, anchorName, parentNodeXpath,
121 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
122 return new ResponseEntity<>(HttpStatus.OK);
126 public ResponseEntity<Object> replaceNode(final String apiVersion,
127 final String dataspaceName, final String anchorName,
128 final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
130 .updateDataNodeAndDescendants(dataspaceName, anchorName, parentNodeXpath,
131 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
132 return new ResponseEntity<>(HttpStatus.OK);
136 public ResponseEntity<Object> replaceListContent(final String parentNodeXpath,
137 final String apiVersion, final String dataspaceName, final String anchorName, final Object jsonData,
138 final String observedTimestamp) {
139 cpsDataService.replaceListContent(dataspaceName, anchorName, parentNodeXpath,
140 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
141 return new ResponseEntity<>(HttpStatus.OK);
145 public ResponseEntity<Void> deleteListOrListElement(final String dataspaceName, final String anchorName,
146 final String listElementXpath, final String observedTimestamp) {
148 .deleteListOrListElement(dataspaceName, anchorName, listElementXpath, toOffsetDateTime(observedTimestamp));
149 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
152 private static boolean isRootXpath(final String xpath) {
153 return ROOT_XPATH.equals(xpath);
156 private static OffsetDateTime toOffsetDateTime(final String datetTimestamp) {
158 return StringUtils.isEmpty(datetTimestamp)
159 ? null : OffsetDateTime.parse(datetTimestamp, ISO_TIMESTAMP_FORMATTER);
160 } catch (final Exception exception) {
161 throw new ValidationException(
162 String.format("observed-timestamp must be in '%s' format", ISO_TIMESTAMP_FORMAT));