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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020-2022 Nordix Foundation
   4  *  Modifications Copyright (C) 2020-2021 Bell Canada.
   5  *  Modifications Copyright (C) 2021 Pantheon.tech
   6  *  Modifications Copyright (C) 2022 TechMahindra Ltd.
   7  *  ================================================================================
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  *  SPDX-License-Identifier: Apache-2.0
  21  *  ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.cps.rest.controller;
  25
  26 import static org.onap.cps.rest.utils.MultipartFileUtil.extractYangResourcesMap;
  27 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED;
  28
  29 import java.util.Collection;
  30 import java.util.List;
  31 import java.util.stream.Collectors;
  32 import javax.validation.Valid;
  33 import javax.validation.constraints.NotNull;
  34 import lombok.RequiredArgsConstructor;
  35 import org.onap.cps.api.CpsAdminService;
  36 import org.onap.cps.api.CpsModuleService;
  37 import org.onap.cps.rest.api.CpsAdminApi;
  38 import org.onap.cps.rest.model.AnchorDetails;
  39 import org.onap.cps.rest.model.DataspaceDetails;
  40 import org.onap.cps.rest.model.SchemaSetDetails;
  41 import org.onap.cps.spi.model.Anchor;
  42 import org.onap.cps.spi.model.Dataspace;
  43 import org.onap.cps.spi.model.SchemaSet;
  44 import org.springframework.http.HttpStatus;
  45 import org.springframework.http.ResponseEntity;
  46 import org.springframework.web.bind.annotation.RequestMapping;
  47 import org.springframework.web.bind.annotation.RestController;
  48 import org.springframework.web.multipart.MultipartFile;
  49
  50 @RestController
  51 @RequestMapping("${rest.api.cps-base-path}")
  52 @RequiredArgsConstructor
  53 public class AdminRestController implements CpsAdminApi {
  54
  55     private final CpsAdminService cpsAdminService;
  56     private final CpsModuleService cpsModuleService;
  57     private final CpsRestInputMapper cpsRestInputMapper;
  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(@NotNull @Valid final String dataspaceName) {
  67         cpsAdminService.createDataspace(dataspaceName);
  68         return new ResponseEntity<>(dataspaceName, HttpStatus.CREATED);
  69     }
  70
  71     /**
  72      * Delete a dataspace.
  73      *
  74      * @param dataspaceName name of dataspace to be deleted
  75      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
  76      */
  77     @Override
  78     public ResponseEntity<Void> deleteDataspace(final String dataspaceName) {
  79         cpsAdminService.deleteDataspace(dataspaceName);
  80         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
  81     }
  82
  83     /**
  84      * Create a {@link SchemaSet}.
  85      *
  86      * @param multipartFile multipart file
  87      * @param schemaSetName schemaset name
  88      * @param dataspaceName dataspace name
  89      * @return a {@Link ResponseEntity} of created schemaset name & {@link HttpStatus} CREATED
  90      */
  91     @Override
  92     public ResponseEntity<String> createSchemaSet(@NotNull @Valid final String schemaSetName,
  93         final String dataspaceName, @Valid final MultipartFile multipartFile) {
  94         cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, extractYangResourcesMap(multipartFile));
  95         return new ResponseEntity<>(schemaSetName, HttpStatus.CREATED);
  96     }
  97
  98     /**
  99      * Get {@link SchemaSetDetails} based on dataspace name & {@link SchemaSet} name.
 100      *
 101      * @param dataspaceName dataspace name
 102      * @param schemaSetName schemaset name
 103      * @return a {@Link ResponseEntity} of {@Link SchemaSetDetails} & {@link HttpStatus} OK
 104      */
 105     @Override
 106     public ResponseEntity<SchemaSetDetails> getSchemaSet(final String dataspaceName, final String schemaSetName) {
 107         final var schemaSet = cpsModuleService.getSchemaSet(dataspaceName, schemaSetName);
 108         final var schemaSetDetails = cpsRestInputMapper.toSchemaSetDetails(schemaSet);
 109         return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK);
 110     }
 111
 112     /**
 113      * Get list of schema sets for a given dataspace name.
 114      *
 115      * @param dataspaceName dataspace name
 116      * @return a {@Link ResponseEntity} of schema sets & {@link HttpStatus} OK
 117      */
 118     @Override
 119     public ResponseEntity<List<SchemaSetDetails>> getSchemaSets(final String dataspaceName) {
 120         final Collection<SchemaSet> schemaSets = cpsModuleService.getSchemaSets(dataspaceName);
 121         final List<SchemaSetDetails> schemaSetDetails = schemaSets.stream().map(cpsRestInputMapper::toSchemaSetDetails)
 122                 .collect(Collectors.toList());
 123         return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK);
 124     }
 125
 126     /**
 127      * Delete a {@link SchemaSet} based on given dataspace name & schemaset name.
 128      *
 129      * @param dataspaceName dataspace name
 130      * @param schemaSetName schemaset name
 131      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
 132      */
 133     @Override
 134     public ResponseEntity<Void> deleteSchemaSet(final String dataspaceName, final String schemaSetName) {
 135         cpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED);
 136         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 137     }
 138
 139     /**
 140      * Create a new anchor.
 141      *
 142      * @param dataspaceName dataspace name
 143      * @param schemaSetName schema set name
 144      * @param anchorName    anchorName
 145      * @return a ResponseEntity with the anchor name & {@link HttpStatus} CREATED
 146      */
 147     @Override
 148     public ResponseEntity<String> createAnchor(final String dataspaceName, @NotNull @Valid final String schemaSetName,
 149         @NotNull @Valid final String anchorName) {
 150         cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName);
 151         return new ResponseEntity<>(anchorName, HttpStatus.CREATED);
 152     }
 153
 154     /**
 155      * Delete an {@link Anchor} based on given dataspace name & anchor name.
 156      *
 157      * @param dataspaceName dataspace name
 158      * @param anchorName anchor name
 159      * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
 160      */
 161     @Override
 162     public ResponseEntity<Void> deleteAnchor(final String dataspaceName, final String anchorName) {
 163         cpsAdminService.deleteAnchor(dataspaceName, anchorName);
 164         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 165     }
 166
 167     /**
 168      * Get an {@link Anchor} based on given dataspace name & anchor name.
 169      *
 170      * @param dataspaceName dataspace name
 171      * @param anchorName anchor name
 172      * @return a {@Link ResponseEntity} of an {@Link AnchorDetails} & {@link HttpStatus} OK
 173      */
 174     @Override
 175     public ResponseEntity<AnchorDetails> getAnchor(final String dataspaceName, final String anchorName) {
 176         final var anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
 177         final var anchorDetails = cpsRestInputMapper.toAnchorDetails(anchor);
 178         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
 179     }
 180
 181     /**
 182      *  Get all {@link Anchor} based on given dataspace name.
 183      *
 184      * @param dataspaceName dataspace name
 185      * @return a {@Link ResponseEntity} of all {@Link AnchorDetails} & {@link HttpStatus} OK
 186      */
 187     @Override
 188     public ResponseEntity<List<AnchorDetails>> getAnchors(final String dataspaceName) {
 189         final Collection<Anchor> anchors = cpsAdminService.getAnchors(dataspaceName);
 190         final List<AnchorDetails> anchorDetails = anchors.stream().map(cpsRestInputMapper::toAnchorDetails)
 191             .collect(Collectors.toList());
 192         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
 193     }
 194
 195     @Override
 196     public ResponseEntity<List<DataspaceDetails>> getAllDataspaces() {
 197         final Collection<Dataspace> dataspaces = cpsAdminService.getAllDataspaces();
 198         final List<DataspaceDetails> dataspaceDetails = dataspaces.stream().map(cpsRestInputMapper::toDataspaceDetails)
 199                 .collect(Collectors.toList());
 200         return new ResponseEntity<>(dataspaceDetails, HttpStatus.OK);
 201     }
 202
 203     @Override
 204     public ResponseEntity<DataspaceDetails> getDataspace(final String dataspaceName) {
 205         final Dataspace dataspace = cpsAdminService.getDataspace(dataspaceName);
 206         final DataspaceDetails dataspaceDetails = cpsRestInputMapper.toDataspaceDetails(dataspace);
 207         return new ResponseEntity<>(dataspaceDetails, HttpStatus.OK);
 208     }
 209 }