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