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.
   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  *
  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 static org.onap.cps.rest.utils.MultipartFileUtil.extractYangResourcesMap;
  26 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED;
  27
  28 import java.util.Collection;
  29 import java.util.List;
  30 import java.util.stream.Collectors;
  31 import org.modelmapper.ModelMapper;
  32 import org.onap.cps.api.CpsAdminService;
  33 import org.onap.cps.api.CpsModuleService;
  34 import org.onap.cps.rest.api.CpsAdminApi;
  35 import org.onap.cps.rest.model.AnchorDetails;
  36 import org.onap.cps.rest.model.SchemaSetDetails;
  37 import org.onap.cps.spi.model.Anchor;
  38 import org.onap.cps.spi.model.SchemaSet;
  39 import org.springframework.beans.factory.annotation.Autowired;
  40 import org.springframework.http.HttpStatus;
  41 import org.springframework.http.ResponseEntity;
  42 import org.springframework.web.bind.annotation.RequestMapping;
  43 import org.springframework.web.bind.annotation.RestController;
  44 import org.springframework.web.multipart.MultipartFile;
  45
  46 @RestController
  47 @RequestMapping("${rest.api.cps-base-path}")
  48 public class AdminRestController implements CpsAdminApi {
  49
  50     @Autowired
  51     private CpsAdminService cpsAdminService;
  52
  53     @Autowired
  54     private CpsModuleService cpsModuleService;
  55
  56     @Autowired
  57     private ModelMapper modelMapper;
  58
  59     /**
  60      * Create a dataspace.
  61      *
  62      * @param dataspaceName dataspace name
  63      * @return a {@Link ResponseEntity} of created dataspace name & {@link HttpStatus} CREATED
  64      */
  65     @Override
  66     public ResponseEntity<String> createDataspace(final String dataspaceName) {
  67         cpsAdminService.createDataspace(dataspaceName);
  68         return new ResponseEntity<>(dataspaceName, HttpStatus.CREATED);
  69     }
  70
  71     /**
  72      * Delete a dataspace based on a given name.
  73      *
  74      * @param dataspaceName dataspace name
  75      * @return a {@Link ResponseEntity} of {@link HttpStatus} NOT_IMPLEMENTED
  76      */
  77     @Override
  78     public ResponseEntity<Object> deleteDataspace(final String dataspaceName) {
  79         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  80     }
  81
  82     /**
  83      * Create a {@link SchemaSet}.
  84      *
  85      * @param multipartFile multipart file
  86      * @param schemaSetName schemaset name
  87      * @param dataspaceName dataspace name
  88      * @return a {@Link ResponseEntity} of created schemaset name & {@link HttpStatus} CREATED
  89      */
  90     @Override
  91     public ResponseEntity<String> createSchemaSet(final MultipartFile multipartFile,
  92         final String schemaSetName, final String dataspaceName) {
  93         cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, extractYangResourcesMap(multipartFile));
  94         return new ResponseEntity<>(schemaSetName, HttpStatus.CREATED);
  95     }
  96
  97     /**
  98      * Get {@link SchemaSetDetails} based on dataspace name & {@link SchemaSet} name.
  99      *
 100      * @param dataspaceName dataspace name
 101      * @param schemaSetName schemaset name
 102      * @return a {@Link ResponseEntity} of {@Link SchemaSetDetails} & {@link HttpStatus} OK
 103      */
 104     @Override
 105     public ResponseEntity<SchemaSetDetails> getSchemaSet(final String dataspaceName, final String schemaSetName) {
 106         final var schemaSet = cpsModuleService.getSchemaSet(dataspaceName, schemaSetName);
 107         final var schemaSetDetails = modelMapper.map(schemaSet, SchemaSetDetails.class);
 108         return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK);
 109     }
 110
 111     /**
 112      * Delete a {@link SchemaSet} based on given dataspace name & schemaset name.
 113      *
 114      * @param dataspaceName dataspace name
 115      * @param schemaSetName schemaset name
 116      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
 117      */
 118     @Override
 119     public ResponseEntity<Void> deleteSchemaSet(final String dataspaceName, final String schemaSetName) {
 120         cpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED);
 121         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 122     }
 123
 124     /**
 125      * Create a new anchor.
 126      *
 127      * @param dataspaceName dataspace name
 128      * @param schemaSetName schema set name
 129      * @param anchorName    anchorName
 130      * @return a ResponseEntity with the anchor name & {@link HttpStatus} CREATED
 131      */
 132     @Override
 133     public ResponseEntity<String> createAnchor(final String dataspaceName, final String schemaSetName,
 134         final String anchorName) {
 135         cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName);
 136         return new ResponseEntity<>(anchorName, HttpStatus.CREATED);
 137     }
 138
 139     /**
 140      * Delete an {@link Anchor} based on given dataspace name & anchor name.
 141      *
 142      * @param dataspaceName dataspace name
 143      * @param anchorName anchor name
 144      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
 145      */
 146     @Override
 147     public ResponseEntity<Void> deleteAnchor(final String dataspaceName, final String anchorName) {
 148         cpsAdminService.deleteAnchor(dataspaceName, anchorName);
 149         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 150     }
 151
 152     /**
 153      * Get an {@link Anchor} based on given dataspace name & anchor name.
 154      *
 155      * @param dataspaceName dataspace name
 156      * @param anchorName anchor name
 157      * @return a {@Link ResponseEntity} of an {@Link AnchorDetails} & {@link HttpStatus} OK
 158      */
 159     @Override
 160     public ResponseEntity<AnchorDetails> getAnchor(final String dataspaceName, final String anchorName) {
 161         final var anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 162         final var anchorDetails = modelMapper.map(anchor, AnchorDetails.class);
 163         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
 164     }
 165
 166     /**
 167      *  Get all {@link Anchor} based on given dataspace name.
 168      *
 169      * @param dataspaceName dataspace name
 170      * @return a {@Link ResponseEntity} of all {@Link AnchorDetails} & {@link HttpStatus} OK
 171      */
 172     @Override
 173     public ResponseEntity<List<AnchorDetails>> getAnchors(final String dataspaceName) {
 174         final Collection<Anchor> anchors = cpsAdminService.getAnchors(dataspaceName);
 175         final List<AnchorDetails> anchorDetails = anchors.stream().map(anchor ->
 176             modelMapper.map(anchor, AnchorDetails.class)).collect(Collectors.toList());
 177         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
 178     }
 179 }