2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020-2023 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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.cps.rest.controller;
26 import static org.onap.cps.rest.utils.MultipartFileUtil.extractYangResourcesMap;
27 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED;
29 import io.micrometer.core.annotation.Timed;
30 import jakarta.validation.Valid;
31 import jakarta.validation.constraints.NotNull;
32 import java.util.Collection;
33 import java.util.List;
34 import java.util.stream.Collectors;
35 import lombok.RequiredArgsConstructor;
36 import org.onap.cps.api.CpsAnchorService;
37 import org.onap.cps.api.CpsDataspaceService;
38 import org.onap.cps.api.CpsModuleService;
39 import org.onap.cps.rest.api.CpsAdminApi;
40 import org.onap.cps.rest.model.AnchorDetails;
41 import org.onap.cps.rest.model.DataspaceDetails;
42 import org.onap.cps.rest.model.SchemaSetDetails;
43 import org.onap.cps.spi.model.Anchor;
44 import org.onap.cps.spi.model.Dataspace;
45 import org.onap.cps.spi.model.SchemaSet;
46 import org.springframework.http.HttpStatus;
47 import org.springframework.http.ResponseEntity;
48 import org.springframework.web.bind.annotation.RequestMapping;
49 import org.springframework.web.bind.annotation.RestController;
50 import org.springframework.web.multipart.MultipartFile;
53 @RequestMapping("${rest.api.cps-base-path}")
54 @RequiredArgsConstructor
55 public class AdminRestController implements CpsAdminApi {
57 private final CpsDataspaceService cpsDataspaceService;
58 private final CpsModuleService cpsModuleService;
59 private final CpsRestInputMapper cpsRestInputMapper;
60 private final CpsAnchorService cpsAnchorService;
65 * @param dataspaceName dataspace name
66 * @return a {@Link ResponseEntity} of created dataspace name & {@link HttpStatus} CREATED
69 public ResponseEntity<String> createDataspace(@NotNull @Valid final String dataspaceName) {
70 cpsDataspaceService.createDataspace(dataspaceName);
71 return new ResponseEntity<>(dataspaceName, HttpStatus.CREATED);
75 * Create a dataspace without returning any response body.
77 * @param dataspaceName dataspace name
78 * @return a {@Link ResponseEntity} of created dataspace name & {@link HttpStatus} CREATED
81 public ResponseEntity<Void> createDataspaceV2(@NotNull @Valid final String dataspaceName) {
82 cpsDataspaceService.createDataspace(dataspaceName);
83 return new ResponseEntity<>(HttpStatus.CREATED);
89 * @param dataspaceName name of dataspace to be deleted
90 * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
93 public ResponseEntity<Void> deleteDataspace(final String apiVersion, final String dataspaceName) {
94 cpsDataspaceService.deleteDataspace(dataspaceName);
95 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
99 * Create a {@link SchemaSet}.
101 * @param dataspaceName dataspace name
102 * @param schemaSetName schemaset name
103 * @param multipartFile multipart file
104 * @return a {@Link ResponseEntity} of created schemaset name & {@link HttpStatus} CREATED
107 public ResponseEntity<String> createSchemaSet(final String dataspaceName,
108 @NotNull @Valid final String schemaSetName,
109 final MultipartFile multipartFile) {
110 cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, extractYangResourcesMap(multipartFile));
111 return new ResponseEntity<>(schemaSetName, HttpStatus.CREATED);
115 * Create a {@link SchemaSet}.
117 * @param dataspaceName dataspace name
118 * @param schemaSetName schemaset name
119 * @param multipartFile multipart file
120 * @return a {@Link ResponseEntity} of created schema set without any response body & {@link HttpStatus} CREATED
123 @Timed(value = "cps.rest.admin.controller.schemaset.create",
124 description = "Time taken to create schemaset from controller")
125 public ResponseEntity<Void> createSchemaSetV2(final String dataspaceName,
126 @NotNull @Valid final String schemaSetName,
127 final MultipartFile multipartFile) {
128 cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, extractYangResourcesMap(multipartFile));
129 return new ResponseEntity<>(HttpStatus.CREATED);
133 * Get {@link SchemaSetDetails} based on dataspace name & {@link SchemaSet} name.
135 * @param apiVersion api version
136 * @param dataspaceName dataspace name
137 * @param schemaSetName schemaset name
138 * @return a {@Link ResponseEntity} of {@Link SchemaSetDetails} & {@link HttpStatus} OK
141 public ResponseEntity<SchemaSetDetails> getSchemaSet(final String apiVersion,
142 final String dataspaceName, final String schemaSetName) {
143 final var schemaSet = cpsModuleService.getSchemaSet(dataspaceName, schemaSetName);
144 final var schemaSetDetails = cpsRestInputMapper.toSchemaSetDetails(schemaSet);
145 return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK);
149 * Get list of schema sets for a given dataspace name.
151 * @param apiVersion api version
152 * @param dataspaceName dataspace name
153 * @return a {@Link ResponseEntity} of schema sets & {@link HttpStatus} OK
156 public ResponseEntity<List<SchemaSetDetails>> getSchemaSets(final String apiVersion, final String dataspaceName) {
157 final Collection<SchemaSet> schemaSets = cpsModuleService.getSchemaSets(dataspaceName);
158 final List<SchemaSetDetails> schemaSetDetails = schemaSets.stream().map(cpsRestInputMapper::toSchemaSetDetails)
159 .collect(Collectors.toList());
160 return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK);
164 * Delete a {@link SchemaSet} based on given dataspace name & schemaset name.
166 * @param apiVersion api version
167 * @param dataspaceName dataspace name
168 * @param schemaSetName schemaset name
169 * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
172 public ResponseEntity<Void> deleteSchemaSet(final String apiVersion,
173 final String dataspaceName, final String schemaSetName) {
174 cpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED);
175 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
179 * Create a new anchor.
181 * @param dataspaceName dataspace name
182 * @param schemaSetName schema set name
183 * @param anchorName anchorName
184 * @return a ResponseEntity with the anchor name & {@link HttpStatus} CREATED
187 public ResponseEntity<String> createAnchor(final String dataspaceName, @NotNull @Valid final String schemaSetName,
188 @NotNull @Valid final String anchorName) {
189 cpsAnchorService.createAnchor(dataspaceName, schemaSetName, anchorName);
190 return new ResponseEntity<>(anchorName, HttpStatus.CREATED);
196 * @param dataspaceName dataspace name
197 * @param schemaSetName schema set name
198 * @param anchorName anchorName
199 * @return a ResponseEntity without response body & {@link HttpStatus} CREATED
202 public ResponseEntity<Void> createAnchorV2(final String dataspaceName, @NotNull @Valid final String schemaSetName,
203 @NotNull @Valid final String anchorName) {
204 cpsAnchorService.createAnchor(dataspaceName, schemaSetName, anchorName);
205 return new ResponseEntity<>(HttpStatus.CREATED);
209 * Delete an {@link Anchor} based on given dataspace name & anchor name.
211 * @param apiVersion api version
212 * @param dataspaceName dataspace name
213 * @param anchorName anchor name
214 * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
217 public ResponseEntity<Void> deleteAnchor(final String apiVersion,
218 final String dataspaceName, final String anchorName) {
219 cpsAnchorService.deleteAnchor(dataspaceName, anchorName);
220 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
224 * Get an {@link Anchor} based on given dataspace name & anchor name.
226 * @param apiVersion api version
227 * @param dataspaceName dataspace name
228 * @param anchorName anchor name
229 * @return a {@Link ResponseEntity} of an {@Link AnchorDetails} & {@link HttpStatus} OK
232 public ResponseEntity<AnchorDetails> getAnchor(final String apiVersion,
233 final String dataspaceName, final String anchorName) {
234 final var anchor = cpsAnchorService.getAnchor(dataspaceName, anchorName);
235 final var anchorDetails = cpsRestInputMapper.toAnchorDetails(anchor);
236 return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
240 * Get all {@link Anchor} based on given dataspace name.
242 * @param apiVersion api version
243 * @param dataspaceName dataspace name
244 * @return a {@Link ResponseEntity} of all {@Link AnchorDetails} & {@link HttpStatus} OK
247 public ResponseEntity<List<AnchorDetails>> getAnchors(final String apiVersion,
248 final String dataspaceName) {
249 final Collection<Anchor> anchors = cpsAnchorService.getAnchors(dataspaceName);
250 final List<AnchorDetails> anchorDetails = anchors.stream().map(cpsRestInputMapper::toAnchorDetails)
251 .collect(Collectors.toList());
252 return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
256 public ResponseEntity<List<DataspaceDetails>> getAllDataspaces(final String apiVersion) {
257 final Collection<Dataspace> dataspaces = cpsDataspaceService.getAllDataspaces();
258 final List<DataspaceDetails> dataspaceDetails = dataspaces.stream().map(cpsRestInputMapper::toDataspaceDetails)
259 .collect(Collectors.toList());
260 return new ResponseEntity<>(dataspaceDetails, HttpStatus.OK);
264 public ResponseEntity<DataspaceDetails> getDataspace(final String apiVersion, final String dataspaceName) {
265 final Dataspace dataspace = cpsDataspaceService.getDataspace(dataspaceName);
266 final DataspaceDetails dataspaceDetails = cpsRestInputMapper.toDataspaceDetails(dataspace);
267 return new ResponseEntity<>(dataspaceDetails, HttpStatus.OK);