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