cps-rest/src/main/java/org/onap/cps/rest/controller/DataRestController.java

   1 /*
   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
  12  *
  13  *        http://www.apache.org/licenses/LICENSE-2.0
  14  *
  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.
  20  *
  21  *  SPDX-License-Identifier: Apache-2.0
  22  *  ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.cps.rest.controller;
  26
  27 import io.micrometer.core.annotation.Timed;
  28 import jakarta.validation.ValidationException;
  29 import java.time.OffsetDateTime;
  30 import java.time.format.DateTimeFormatter;
  31 import java.util.ArrayList;
  32 import java.util.Collection;
  33 import java.util.List;
  34 import java.util.Map;
  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.spi.model.DeltaReport;
  42 import org.onap.cps.utils.ContentType;
  43 import org.onap.cps.utils.DataMapUtils;
  44 import org.onap.cps.utils.JsonObjectMapper;
  45 import org.onap.cps.utils.PrefixResolver;
  46 import org.springframework.http.HttpStatus;
  47 import org.springframework.http.MediaType;
  48 import org.springframework.http.ResponseEntity;
  49 import org.springframework.web.bind.annotation.RequestHeader;
  50 import org.springframework.web.bind.annotation.RequestMapping;
  51 import org.springframework.web.bind.annotation.RestController;
  52
  53 @RestController
  54 @RequestMapping("${rest.api.cps-base-path}")
  55 @RequiredArgsConstructor
  56 public class DataRestController implements CpsDataApi {
  57
  58     private static final String ROOT_XPATH = "/";
  59     private static final String ISO_TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
  60     private static final DateTimeFormatter ISO_TIMESTAMP_FORMATTER = DateTimeFormatter.ofPattern(ISO_TIMESTAMP_FORMAT);
  61
  62     private final CpsDataService cpsDataService;
  63     private final JsonObjectMapper jsonObjectMapper;
  64     private final PrefixResolver prefixResolver;
  65
  66     @Override
  67     public ResponseEntity<String> createNode(final String apiVersion,
  68                                              final String dataspaceName, final String anchorName,
  69                                              @RequestHeader(value = "Content-Type") final String contentTypeHeader,
  70                                              final String nodeData, final String parentNodeXpath,
  71                                              final String observedTimestamp) {
  72         final ContentType contentType = contentTypeHeader.contains(MediaType.APPLICATION_XML_VALUE) ? ContentType.XML
  73                 : ContentType.JSON;
  74         if (isRootXpath(parentNodeXpath)) {
  75             cpsDataService.saveData(dataspaceName, anchorName, nodeData,
  76                     toOffsetDateTime(observedTimestamp), contentType);
  77         } else {
  78             cpsDataService.saveData(dataspaceName, anchorName, parentNodeXpath,
  79                     nodeData, toOffsetDateTime(observedTimestamp), contentType);
  80         }
  81         return new ResponseEntity<>(HttpStatus.CREATED);
  82     }
  83
  84     @Override
  85     public ResponseEntity<Void> deleteDataNode(final String apiVersion,
  86         final String dataspaceName, final String anchorName,
  87         final String xpath, final String observedTimestamp) {
  88         cpsDataService.deleteDataNode(dataspaceName, anchorName, xpath,
  89             toOffsetDateTime(observedTimestamp));
  90         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
  91     }
  92
  93     @Override
  94     public ResponseEntity<String> addListElements(final String apiVersion, final String dataspaceName,
  95                                                   final String anchorName, final String parentNodeXpath,
  96                                                   final Object jsonData, final String observedTimestamp) {
  97         cpsDataService.saveListElements(dataspaceName, anchorName, parentNodeXpath,
  98                 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
  99         return new ResponseEntity<>(HttpStatus.CREATED);
 100     }
 101
 102     @Override
 103     @Timed(value = "cps.data.controller.datanode.get.v1",
 104             description = "Time taken to get data node")
 105     public ResponseEntity<Object> getNodeByDataspaceAndAnchor(final String dataspaceName,
 106         final String anchorName, final String xpath, final Boolean includeDescendants) {
 107         final FetchDescendantsOption fetchDescendantsOption = Boolean.TRUE.equals(includeDescendants)
 108             ? FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS : FetchDescendantsOption.OMIT_DESCENDANTS;
 109         final DataNode dataNode = cpsDataService.getDataNodes(dataspaceName, anchorName, xpath,
 110             fetchDescendantsOption).iterator().next();
 111         final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, dataNode.getXpath());
 112         return new ResponseEntity<>(DataMapUtils.toDataMapWithIdentifier(dataNode, prefix), HttpStatus.OK);
 113     }
 114
 115     @Override
 116     @Timed(value = "cps.data.controller.datanode.get.v2",
 117             description = "Time taken to get data node")
 118     public ResponseEntity<Object> getNodeByDataspaceAndAnchorV2(final String dataspaceName, final String anchorName,
 119                                                                 final String xpath,
 120                                                                 final String fetchDescendantsOptionAsString) {
 121         final FetchDescendantsOption fetchDescendantsOption =
 122                 FetchDescendantsOption.getFetchDescendantsOption(fetchDescendantsOptionAsString);
 123         final Collection<DataNode> dataNodes = cpsDataService.getDataNodes(dataspaceName, anchorName, xpath,
 124                 fetchDescendantsOption);
 125         final List<Map<String, Object>> dataMaps = new ArrayList<>(dataNodes.size());
 126         for (final DataNode dataNode: dataNodes) {
 127             final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, dataNode.getXpath());
 128             final Map<String, Object> dataMap = DataMapUtils.toDataMapWithIdentifier(dataNode, prefix);
 129             dataMaps.add(dataMap);
 130         }
 131         return new ResponseEntity<>(jsonObjectMapper.asJsonString(dataMaps), HttpStatus.OK);
 132     }
 133
 134     @Override
 135     public ResponseEntity<Object> updateNodeLeaves(final String apiVersion, final String dataspaceName,
 136         final String anchorName, final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
 137         cpsDataService.updateNodeLeaves(dataspaceName, anchorName, parentNodeXpath,
 138                 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
 139         return new ResponseEntity<>(HttpStatus.OK);
 140     }
 141
 142     @Override
 143     public ResponseEntity<Object> replaceNode(final String apiVersion,
 144         final String dataspaceName, final String anchorName,
 145         final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
 146         cpsDataService
 147                 .updateDataNodeAndDescendants(dataspaceName, anchorName, parentNodeXpath,
 148                         jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
 149         return new ResponseEntity<>(HttpStatus.OK);
 150     }
 151
 152     @Override
 153     public ResponseEntity<Object> replaceListContent(final String apiVersion,
 154                                                      final String dataspaceName, final String anchorName,
 155                                                      final String parentNodeXpath, final Object jsonData,
 156         final String observedTimestamp) {
 157         cpsDataService.replaceListContent(dataspaceName, anchorName, parentNodeXpath,
 158                 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
 159         return new ResponseEntity<>(HttpStatus.OK);
 160     }
 161
 162     @Override
 163     public ResponseEntity<Void> deleteListOrListElement(final String dataspaceName, final String anchorName,
 164         final String listElementXpath, final String observedTimestamp) {
 165         cpsDataService
 166             .deleteListOrListElement(dataspaceName, anchorName, listElementXpath, toOffsetDateTime(observedTimestamp));
 167         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 168     }
 169
 170     @Override
 171     @Timed(value = "cps.data.controller.get.delta",
 172             description = "Time taken to get delta between anchors")
 173     public ResponseEntity<Object> getDeltaByDataspaceAndAnchors(final String dataspaceName,
 174                                                                            final String sourceAnchorName,
 175                                                                            final String targetAnchorName,
 176                                                                            final String xpath,
 177                                                                            final String descendants) {
 178         final FetchDescendantsOption fetchDescendantsOption =
 179                 FetchDescendantsOption.getFetchDescendantsOption(descendants);
 180
 181         final List<DeltaReport> deltaBetweenAnchors =
 182                 cpsDataService.getDeltaByDataspaceAndAnchors(dataspaceName, sourceAnchorName,
 183                 targetAnchorName, xpath, fetchDescendantsOption);
 184         return new ResponseEntity<>(jsonObjectMapper.asJsonString(deltaBetweenAnchors), HttpStatus.OK);
 185     }
 186
 187     private static boolean isRootXpath(final String xpath) {
 188         return ROOT_XPATH.equals(xpath);
 189     }
 190
 191     private static OffsetDateTime toOffsetDateTime(final String datetTimestamp) {
 192         try {
 193             return StringUtils.isEmpty(datetTimestamp)
 194                 ? null : OffsetDateTime.parse(datetTimestamp, ISO_TIMESTAMP_FORMATTER);
 195         } catch (final Exception exception) {
 196             throw new ValidationException(
 197                 String.format("observed-timestamp must be in '%s' format", ISO_TIMESTAMP_FORMAT));
 198         }
 199     }
 200 }