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-2022 Nordix Foundation
   6  *  Modifications Copyright (C) 2022 TechMahindra Ltd.
   7  *  ================================================================================
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  *  SPDX-License-Identifier: Apache-2.0
  21  *  ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.cps.rest.controller;
  25
  26 import java.time.OffsetDateTime;
  27 import java.time.format.DateTimeFormatter;
  28 import javax.validation.ValidationException;
  29 import lombok.RequiredArgsConstructor;
  30 import org.apache.commons.lang3.StringUtils;
  31 import org.onap.cps.api.CpsDataService;
  32 import org.onap.cps.rest.api.CpsDataApi;
  33 import org.onap.cps.spi.FetchDescendantsOption;
  34 import org.onap.cps.spi.model.DataNode;
  35 import org.onap.cps.utils.DataMapUtils;
  36 import org.onap.cps.utils.JsonObjectMapper;
  37 import org.onap.cps.utils.PrefixResolver;
  38 import org.springframework.http.HttpStatus;
  39 import org.springframework.http.ResponseEntity;
  40 import org.springframework.web.bind.annotation.RequestMapping;
  41 import org.springframework.web.bind.annotation.RestController;
  42
  43 @RestController
  44 @RequestMapping("${rest.api.cps-base-path}")
  45 @RequiredArgsConstructor
  46 public class DataRestController implements CpsDataApi {
  47
  48     private static final String ROOT_XPATH = "/";
  49     private static final String ISO_TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
  50     private static final DateTimeFormatter ISO_TIMESTAMP_FORMATTER = DateTimeFormatter.ofPattern(ISO_TIMESTAMP_FORMAT);
  51
  52     private final CpsDataService cpsDataService;
  53     private final JsonObjectMapper jsonObjectMapper;
  54     private final PrefixResolver prefixResolver;
  55
  56     @Override
  57     public ResponseEntity<String> createNode(final String apiVersion,
  58         final String dataspaceName, final String anchorName,
  59         final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
  60         final String jsonDataAsString = jsonObjectMapper.asJsonString(jsonData);
  61         if (isRootXpath(parentNodeXpath)) {
  62             cpsDataService.saveData(dataspaceName, anchorName, jsonDataAsString,
  63                     toOffsetDateTime(observedTimestamp));
  64         } else {
  65             cpsDataService.saveData(dataspaceName, anchorName, parentNodeXpath,
  66                     jsonDataAsString, toOffsetDateTime(observedTimestamp));
  67         }
  68         return new ResponseEntity<>(HttpStatus.CREATED);
  69     }
  70
  71     @Override
  72     public ResponseEntity<Void> deleteDataNode(final String apiVersion,
  73         final String dataspaceName, final String anchorName,
  74         final String xpath, final String observedTimestamp) {
  75         cpsDataService.deleteDataNode(dataspaceName, anchorName, xpath,
  76             toOffsetDateTime(observedTimestamp));
  77         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
  78     }
  79
  80     @Override
  81     public ResponseEntity<String> addListElements(final String parentNodeXpath, final String apiVersion,
  82         final String dataspaceName, final String anchorName, final Object jsonData, final String observedTimestamp) {
  83         cpsDataService.saveListElements(dataspaceName, anchorName, parentNodeXpath,
  84                 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
  85         return new ResponseEntity<>(HttpStatus.CREATED);
  86     }
  87
  88     @Override
  89     public ResponseEntity<Object> getNodeByDataspaceAndAnchor(final String apiVersion,
  90         final String dataspaceName, final String anchorName, final String xpath, final Boolean includeDescendants) {
  91         final FetchDescendantsOption fetchDescendantsOption = Boolean.TRUE.equals(includeDescendants)
  92             ? FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS : FetchDescendantsOption.OMIT_DESCENDANTS;
  93         final DataNode dataNode = cpsDataService.getDataNode(dataspaceName, anchorName, xpath,
  94             fetchDescendantsOption);
  95         final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, xpath);
  96         return new ResponseEntity<>(DataMapUtils.toDataMapWithIdentifier(dataNode, prefix), HttpStatus.OK);
  97     }
  98
  99     @Override
 100     public ResponseEntity<Object> updateNodeLeaves(final String apiVersion, final String dataspaceName,
 101         final String anchorName, final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
 102         cpsDataService.updateNodeLeaves(dataspaceName, anchorName, parentNodeXpath,
 103                 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
 104         return new ResponseEntity<>(HttpStatus.OK);
 105     }
 106
 107     @Override
 108     public ResponseEntity<Object> replaceNode(final String apiVersion,
 109         final String dataspaceName, final String anchorName,
 110         final Object jsonData, final String parentNodeXpath, final String observedTimestamp) {
 111         cpsDataService
 112                 .updateDataNodeAndDescendants(dataspaceName, anchorName, parentNodeXpath,
 113                         jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
 114         return new ResponseEntity<>(HttpStatus.OK);
 115     }
 116
 117     @Override
 118     public ResponseEntity<Object> replaceListContent(final String parentNodeXpath,
 119         final String apiVersion, final String dataspaceName, final String anchorName, final Object jsonData,
 120         final String observedTimestamp) {
 121         cpsDataService.replaceListContent(dataspaceName, anchorName, parentNodeXpath,
 122                 jsonObjectMapper.asJsonString(jsonData), toOffsetDateTime(observedTimestamp));
 123         return new ResponseEntity<>(HttpStatus.OK);
 124     }
 125
 126     @Override
 127     public ResponseEntity<Void> deleteListOrListElement(final String dataspaceName, final String anchorName,
 128         final String listElementXpath, final String observedTimestamp) {
 129         cpsDataService
 130             .deleteListOrListElement(dataspaceName, anchorName, listElementXpath, toOffsetDateTime(observedTimestamp));
 131         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 132     }
 133
 134     private static boolean isRootXpath(final String xpath) {
 135         return ROOT_XPATH.equals(xpath);
 136     }
 137
 138     private static OffsetDateTime toOffsetDateTime(final String datetTimestamp) {
 139         try {
 140             return StringUtils.isEmpty(datetTimestamp)
 141                 ? null : OffsetDateTime.parse(datetTimestamp, ISO_TIMESTAMP_FORMATTER);
 142         } catch (final Exception exception) {
 143             throw new ValidationException(
 144                 String.format("observed-timestamp must be in '%s' format", ISO_TIMESTAMP_FORMAT));
 145         }
 146     }
 147 }