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

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
   5  *  Modifications Copyright (C) 2021 Pantheon.tech
   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  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.rest.controller;
  23
  24 import static org.onap.cps.rest.utils.MultipartFileUtil.extractYangResourcesMap;
  25 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED;
  26
  27 import java.util.Collection;
  28 import java.util.List;
  29 import java.util.stream.Collectors;
  30 import org.modelmapper.ModelMapper;
  31 import org.onap.cps.api.CpsAdminService;
  32 import org.onap.cps.api.CpsModuleService;
  33 import org.onap.cps.rest.api.CpsAdminApi;
  34 import org.onap.cps.rest.model.AnchorDetails;
  35 import org.onap.cps.rest.model.SchemaSetDetails;
  36 import org.onap.cps.spi.model.Anchor;
  37 import org.onap.cps.spi.model.SchemaSet;
  38 import org.springframework.beans.factory.annotation.Autowired;
  39 import org.springframework.http.HttpStatus;
  40 import org.springframework.http.ResponseEntity;
  41 import org.springframework.web.bind.annotation.RequestMapping;
  42 import org.springframework.web.bind.annotation.RestController;
  43 import org.springframework.web.multipart.MultipartFile;
  44
  45 @RestController
  46 @RequestMapping("${rest.api.cps-base-path}")
  47 public class AdminRestController implements CpsAdminApi {
  48
  49     @Autowired
  50     private CpsAdminService cpsAdminService;
  51
  52     @Autowired
  53     private CpsModuleService cpsModuleService;
  54
  55     @Autowired
  56     private ModelMapper modelMapper;
  57
  58     /**
  59      * Create a dataspace.
  60      *
  61      * @param dataspaceName dataspace name
  62      * @return a {@Link ResponseEntity} of created dataspace name & {@link HttpStatus} CREATED
  63      */
  64     @Override
  65     public ResponseEntity<String> createDataspace(final String dataspaceName) {
  66         cpsAdminService.createDataspace(dataspaceName);
  67         return new ResponseEntity<>(dataspaceName, HttpStatus.CREATED);
  68     }
  69
  70     /**
  71      * Delete a dataspace based on a given name.
  72      *
  73      * @param dataspaceName dataspace name
  74      * @return a {@Link ResponseEntity} of {@link HttpStatus} NOT_IMPLEMENTED
  75      */
  76     @Override
  77     public ResponseEntity<Object> deleteDataspace(final String dataspaceName) {
  78         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  79     }
  80
  81     /**
  82      * Create a {@link SchemaSet}.
  83      *
  84      * @param multipartFile multipart file
  85      * @param schemaSetName schemaset name
  86      * @param dataspaceName dataspace name
  87      * @return a {@Link ResponseEntity} of created schemaset name & {@link HttpStatus} CREATED
  88      */
  89     @Override
  90     public ResponseEntity<String> createSchemaSet(final MultipartFile multipartFile,
  91         final String schemaSetName, final String dataspaceName) {
  92         cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, extractYangResourcesMap(multipartFile));
  93         return new ResponseEntity<>(schemaSetName, HttpStatus.CREATED);
  94     }
  95
  96     /**
  97      * Get {@link SchemaSetDetails} based on dataspace name & {@link SchemaSet} name.
  98      *
  99      * @param dataspaceName dataspace name
 100      * @param schemaSetName schemaset name
 101      * @return a {@Link ResponseEntity} of {@Link SchemaSetDetails} & {@link HttpStatus} OK
 102      */
 103     @Override
 104     public ResponseEntity<SchemaSetDetails> getSchemaSet(final String dataspaceName, final String schemaSetName) {
 105         final var schemaSet = cpsModuleService.getSchemaSet(dataspaceName, schemaSetName);
 106         final SchemaSetDetails schemaSetDetails = modelMapper.map(schemaSet, SchemaSetDetails.class);
 107         return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK);
 108     }
 109
 110     /**
 111      * Delete a {@link SchemaSet} based on given dataspace name & schemaset name.
 112      *
 113      * @param dataspaceName dataspace name
 114      * @param schemaSetName schemaset name
 115      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
 116      */
 117     @Override
 118     public ResponseEntity<Void> deleteSchemaSet(final String dataspaceName, final String schemaSetName) {
 119         cpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED);
 120         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 121     }
 122
 123     /**
 124      * Create a new anchor.
 125      *
 126      * @param dataspaceName dataspace name
 127      * @param schemaSetName schema set name
 128      * @param anchorName    anchorName
 129      * @return a ResponseEntity with the anchor name & {@link HttpStatus} CREATED
 130      */
 131     @Override
 132     public ResponseEntity<String> createAnchor(final String dataspaceName, final String schemaSetName,
 133         final String anchorName) {
 134         cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName);
 135         return new ResponseEntity<>(anchorName, HttpStatus.CREATED);
 136     }
 137
 138     /**
 139      * Delete an {@link Anchor} based on given dataspace name & anchor name.
 140      *
 141      * @param dataspaceName dataspace name
 142      * @param anchorName anchor name
 143      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
 144      */
 145     @Override
 146     public ResponseEntity<Void> deleteAnchor(final String dataspaceName, final String anchorName) {
 147         cpsAdminService.deleteAnchor(dataspaceName, anchorName);
 148         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 149     }
 150
 151     /**
 152      * Get an {@link Anchor} based on given dataspace name & anchor name.
 153      *
 154      * @param dataspaceName dataspace name
 155      * @param anchorName anchor name
 156      * @return a {@Link ResponseEntity} of an {@Link AnchorDetails} & {@link HttpStatus} OK
 157      */
 158     @Override
 159     public ResponseEntity<AnchorDetails> getAnchor(final String dataspaceName, final String anchorName) {
 160         final var anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 161         final AnchorDetails anchorDetails = modelMapper.map(anchor, AnchorDetails.class);
 162         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
 163     }
 164
 165     /**
 166      *  Get all {@link Anchor} based on given dataspace name.
 167      *
 168      * @param dataspaceName dataspace name
 169      * @return a {@Link ResponseEntity} of all {@Link AnchorDetails} & {@link HttpStatus} OK
 170      */
 171     @Override
 172     public ResponseEntity<List<AnchorDetails>> getAnchors(final String dataspaceName) {
 173         final Collection<Anchor> anchors = cpsAdminService.getAnchors(dataspaceName);
 174         final List<AnchorDetails> anchorDetails = anchors.stream().map(anchor ->
 175             modelMapper.map(anchor, AnchorDetails.class)).collect(Collectors.toList());
 176         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
 177     }
 178 }