/* * ============LICENSE_START======================================================= * Copyright (C) 2020-2023 Nordix Foundation * Modifications Copyright (C) 2020-2021 Bell Canada. * Modifications Copyright (C) 2021 Pantheon.tech * Modifications Copyright (C) 2022 TechMahindra Ltd. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * SPDX-License-Identifier: Apache-2.0 * ============LICENSE_END========================================================= */ package org.onap.cps.rest.controller; import static org.onap.cps.rest.utils.MultipartFileUtil.extractYangResourcesMap; import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED; import io.micrometer.core.annotation.Timed; import java.util.Collection; import java.util.List; import java.util.stream.Collectors; import javax.validation.Valid; import javax.validation.constraints.NotNull; import lombok.RequiredArgsConstructor; import org.onap.cps.api.CpsAdminService; import org.onap.cps.api.CpsModuleService; import org.onap.cps.rest.api.CpsAdminApi; import org.onap.cps.rest.model.AnchorDetails; import org.onap.cps.rest.model.DataspaceDetails; import org.onap.cps.rest.model.SchemaSetDetails; import org.onap.cps.spi.model.Anchor; import org.onap.cps.spi.model.Dataspace; import org.onap.cps.spi.model.SchemaSet; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.multipart.MultipartFile; @RestController @RequestMapping("${rest.api.cps-base-path}") @RequiredArgsConstructor public class AdminRestController implements CpsAdminApi { private final CpsAdminService cpsAdminService; private final CpsModuleService cpsModuleService; private final CpsRestInputMapper cpsRestInputMapper; /** * Create a dataspace. * * @param dataspaceName dataspace name * @return a {@Link ResponseEntity} of created dataspace name & {@link HttpStatus} CREATED */ @Override public ResponseEntity createDataspace(@NotNull @Valid final String dataspaceName) { cpsAdminService.createDataspace(dataspaceName); return new ResponseEntity<>(dataspaceName, HttpStatus.CREATED); } /** * Create a dataspace without returning any response body. * * @param dataspaceName dataspace name * @return a {@Link ResponseEntity} of created dataspace name & {@link HttpStatus} CREATED */ @Override public ResponseEntity createDataspaceV2(@NotNull @Valid final String dataspaceName) { cpsAdminService.createDataspace(dataspaceName); return new ResponseEntity<>(HttpStatus.CREATED); } /** * Delete a dataspace. * * @param dataspaceName name of dataspace to be deleted * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT */ @Override public ResponseEntity deleteDataspace(final String apiVersion, final String dataspaceName) { cpsAdminService.deleteDataspace(dataspaceName); return new ResponseEntity<>(HttpStatus.NO_CONTENT); } /** * Create a {@link SchemaSet}. * * @param dataspaceName dataspace name * @param schemaSetName schemaset name * @param multipartFile multipart file * @return a {@Link ResponseEntity} of created schemaset name & {@link HttpStatus} CREATED */ @Override public ResponseEntity createSchemaSet(final String dataspaceName, @NotNull @Valid final String schemaSetName, final MultipartFile multipartFile) { cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, extractYangResourcesMap(multipartFile)); return new ResponseEntity<>(schemaSetName, HttpStatus.CREATED); } /** * Create a {@link SchemaSet}. * * @param dataspaceName dataspace name * @param schemaSetName schemaset name * @param multipartFile multipart file * @return a {@Link ResponseEntity} of created schema set without any response body & {@link HttpStatus} CREATED */ @Override @Timed(value = "cps.rest.admin.controller.schemaset.create", description = "Time taken to create schemaset from controller") public ResponseEntity createSchemaSetV2(final String dataspaceName, @NotNull @Valid final String schemaSetName, final MultipartFile multipartFile) { cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, extractYangResourcesMap(multipartFile)); return new ResponseEntity<>(HttpStatus.CREATED); } /** * Get {@link SchemaSetDetails} based on dataspace name & {@link SchemaSet} name. * * @param apiVersion api version * @param dataspaceName dataspace name * @param schemaSetName schemaset name * @return a {@Link ResponseEntity} of {@Link SchemaSetDetails} & {@link HttpStatus} OK */ @Override public ResponseEntity getSchemaSet(final String apiVersion, final String dataspaceName, final String schemaSetName) { final var schemaSet = cpsModuleService.getSchemaSet(dataspaceName, schemaSetName); final var schemaSetDetails = cpsRestInputMapper.toSchemaSetDetails(schemaSet); return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK); } /** * Get list of schema sets for a given dataspace name. * * @param apiVersion api version * @param dataspaceName dataspace name * @return a {@Link ResponseEntity} of schema sets & {@link HttpStatus} OK */ @Override public ResponseEntity> getSchemaSets(final String apiVersion, final String dataspaceName) { final Collection schemaSets = cpsModuleService.getSchemaSets(dataspaceName); final List schemaSetDetails = schemaSets.stream().map(cpsRestInputMapper::toSchemaSetDetails) .collect(Collectors.toList()); return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK); } /** * Delete a {@link SchemaSet} based on given dataspace name & schemaset name. * * @param apiVersion api version * @param dataspaceName dataspace name * @param schemaSetName schemaset name * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT */ @Override public ResponseEntity deleteSchemaSet(final String apiVersion, final String dataspaceName, final String schemaSetName) { cpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED); return new ResponseEntity<>(HttpStatus.NO_CONTENT); } /** * Create a new anchor. * * @param dataspaceName dataspace name * @param schemaSetName schema set name * @param anchorName anchorName * @return a ResponseEntity with the anchor name & {@link HttpStatus} CREATED */ @Override public ResponseEntity createAnchor(final String dataspaceName, @NotNull @Valid final String schemaSetName, @NotNull @Valid final String anchorName) { cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName); return new ResponseEntity<>(anchorName, HttpStatus.CREATED); } /** * Create an anchor. * * @param dataspaceName dataspace name * @param schemaSetName schema set name * @param anchorName anchorName * @return a ResponseEntity without response body & {@link HttpStatus} CREATED */ @Override public ResponseEntity createAnchorV2(final String dataspaceName, @NotNull @Valid final String schemaSetName, @NotNull @Valid final String anchorName) { cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName); return new ResponseEntity<>(HttpStatus.CREATED); } /** * Delete an {@link Anchor} based on given dataspace name & anchor name. * * @param apiVersion api version * @param dataspaceName dataspace name * @param anchorName anchor name * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT */ @Override public ResponseEntity deleteAnchor(final String apiVersion, final String dataspaceName, final String anchorName) { cpsAdminService.deleteAnchor(dataspaceName, anchorName); return new ResponseEntity<>(HttpStatus.NO_CONTENT); } /** * Get an {@link Anchor} based on given dataspace name & anchor name. * * @param apiVersion api version * @param dataspaceName dataspace name * @param anchorName anchor name * @return a {@Link ResponseEntity} of an {@Link AnchorDetails} & {@link HttpStatus} OK */ @Override public ResponseEntity getAnchor(final String apiVersion, final String dataspaceName, final String anchorName) { final var anchor = cpsAdminService.getAnchor(dataspaceName, anchorName); final var anchorDetails = cpsRestInputMapper.toAnchorDetails(anchor); return new ResponseEntity<>(anchorDetails, HttpStatus.OK); } /** * Get all {@link Anchor} based on given dataspace name. * * @param apiVersion api version * @param dataspaceName dataspace name * @return a {@Link ResponseEntity} of all {@Link AnchorDetails} & {@link HttpStatus} OK */ @Override public ResponseEntity> getAnchors(final String apiVersion, final String dataspaceName) { final Collection anchors = cpsAdminService.getAnchors(dataspaceName); final List anchorDetails = anchors.stream().map(cpsRestInputMapper::toAnchorDetails) .collect(Collectors.toList()); return new ResponseEntity<>(anchorDetails, HttpStatus.OK); } @Override public ResponseEntity> getAllDataspaces(final String apiVersion) { final Collection dataspaces = cpsAdminService.getAllDataspaces(); final List dataspaceDetails = dataspaces.stream().map(cpsRestInputMapper::toDataspaceDetails) .collect(Collectors.toList()); return new ResponseEntity<>(dataspaceDetails, HttpStatus.OK); } @Override public ResponseEntity getDataspace(final String apiVersion, final String dataspaceName) { final Dataspace dataspace = cpsAdminService.getDataspace(dataspaceName); final DataspaceDetails dataspaceDetails = cpsRestInputMapper.toDataspaceDetails(dataspace); return new ResponseEntity<>(dataspaceDetails, HttpStatus.OK); } }