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      * Create a {@link SchemaSet}.
  75      *
  76      * @param multipartFile multipart file
  77      * @param schemaSetName schemaset name
  78      * @param dataspaceName dataspace name
  79      * @return a {@Link ResponseEntity} of created schemaset name & {@link HttpStatus} CREATED
  80      */
  81     @Override
  82     public ResponseEntity<String> createSchemaSet(@NotNull @Valid final String schemaSetName,
  83         final String dataspaceName, @Valid final MultipartFile multipartFile) {
  84         cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, extractYangResourcesMap(multipartFile));
  85         return new ResponseEntity<>(schemaSetName, HttpStatus.CREATED);
  86     }
  87
  88     /**
  89      * Get {@link SchemaSetDetails} based on dataspace name & {@link SchemaSet} name.
  90      *
  91      * @param dataspaceName dataspace name
  92      * @param schemaSetName schemaset name
  93      * @return a {@Link ResponseEntity} of {@Link SchemaSetDetails} & {@link HttpStatus} OK
  94      */
  95     @Override
  96     public ResponseEntity<SchemaSetDetails> getSchemaSet(final String dataspaceName, final String schemaSetName) {
  97         final var schemaSet = cpsModuleService.getSchemaSet(dataspaceName, schemaSetName);
  98         final var schemaSetDetails = modelMapper.map(schemaSet, SchemaSetDetails.class);
  99         return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK);
 100     }
 101
 102     /**
 103      * Delete a {@link SchemaSet} based on given dataspace name & schemaset name.
 104      *
 105      * @param dataspaceName dataspace name
 106      * @param schemaSetName schemaset name
 107      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
 108      */
 109     @Override
 110     public ResponseEntity<Void> deleteSchemaSet(final String dataspaceName, final String schemaSetName) {
 111         cpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED);
 112         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 113     }
 114
 115     /**
 116      * Create a new anchor.
 117      *
 118      * @param dataspaceName dataspace name
 119      * @param schemaSetName schema set name
 120      * @param anchorName    anchorName
 121      * @return a ResponseEntity with the anchor name & {@link HttpStatus} CREATED
 122      */
 123     @Override
 124     public ResponseEntity<String> createAnchor(final String dataspaceName, @NotNull @Valid final String schemaSetName,
 125         @NotNull @Valid final String anchorName) {
 126         cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName);
 127         return new ResponseEntity<>(anchorName, HttpStatus.CREATED);
 128     }
 129
 130     /**
 131      * Delete an {@link Anchor} based on given dataspace name & anchor name.
 132      *
 133      * @param dataspaceName dataspace name
 134      * @param anchorName anchor name
 135      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
 136      */
 137     @Override
 138     public ResponseEntity<Void> deleteAnchor(final String dataspaceName, final String anchorName) {
 139         cpsAdminService.deleteAnchor(dataspaceName, anchorName);
 140         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 141     }
 142
 143     /**
 144      * Get an {@link Anchor} based on given dataspace name & anchor name.
 145      *
 146      * @param dataspaceName dataspace name
 147      * @param anchorName anchor name
 148      * @return a {@Link ResponseEntity} of an {@Link AnchorDetails} & {@link HttpStatus} OK
 149      */
 150     @Override
 151     public ResponseEntity<AnchorDetails> getAnchor(final String dataspaceName, final String anchorName) {
 152         final var anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 153         final var anchorDetails = modelMapper.map(anchor, AnchorDetails.class);
 154         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
 155     }
 156
 157     /**
 158      *  Get all {@link Anchor} based on given dataspace name.
 159      *
 160      * @param dataspaceName dataspace name
 161      * @return a {@Link ResponseEntity} of all {@Link AnchorDetails} & {@link HttpStatus} OK
 162      */
 163     @Override
 164     public ResponseEntity<List<AnchorDetails>> getAnchors(final String dataspaceName) {
 165         final Collection<Anchor> anchors = cpsAdminService.getAnchors(dataspaceName);
 166         final List<AnchorDetails> anchorDetails = anchors.stream().map(anchor ->
 167             modelMapper.map(anchor, AnchorDetails.class)).collect(Collectors.toList());
 168         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
 169     }
 170 }