2 * Copyright © 2019 Bell Canada Intellectual Property.
3 * Modifications Copyright © 2019 IBM.
4 * Modifications Copyright © 2019 Orange.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
19 package org.onap.ccsdk.cds.blueprintsprocessor.designer.api
21 import io.swagger.annotations.ApiOperation
22 import io.swagger.annotations.ApiParam
23 import org.jetbrains.annotations.NotNull
24 import org.onap.ccsdk.cds.blueprintsprocessor.db.primary.domain.BlueprintModelSearch
25 import org.onap.ccsdk.cds.blueprintsprocessor.designer.api.handler.BluePrintModelHandler
26 import org.onap.ccsdk.cds.blueprintsprocessor.designer.api.utils.BlueprintSortByOption
27 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.monoMdc
28 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintException
29 import org.springframework.core.io.Resource
30 import org.springframework.data.domain.Page
31 import org.springframework.data.domain.PageRequest
32 import org.springframework.data.domain.Sort
33 import org.springframework.http.HttpStatus
34 import org.springframework.http.MediaType
35 import org.springframework.http.ResponseEntity
36 import org.springframework.http.codec.multipart.FilePart
37 import org.springframework.security.access.prepost.PreAuthorize
38 import org.springframework.web.bind.annotation.DeleteMapping
39 import org.springframework.web.bind.annotation.GetMapping
40 import org.springframework.web.bind.annotation.PathVariable
41 import org.springframework.web.bind.annotation.PostMapping
42 import org.springframework.web.bind.annotation.RequestBody
43 import org.springframework.web.bind.annotation.RequestMapping
44 import org.springframework.web.bind.annotation.RequestParam
45 import org.springframework.web.bind.annotation.RequestPart
46 import org.springframework.web.bind.annotation.ResponseBody
47 import org.springframework.web.bind.annotation.RestController
48 import reactor.core.publisher.Mono
51 * BlueprintModelController Purpose: Handle controllerBlueprint API request
57 @RequestMapping("/api/v1/blueprint-model")
58 open class BlueprintModelController(private val bluePrintModelHandler: BluePrintModelHandler) {
61 path = arrayOf("/bootstrap"), produces = arrayOf(MediaType.APPLICATION_JSON_VALUE),
62 consumes = arrayOf(MediaType.APPLICATION_JSON_VALUE)
65 @Throws(BluePrintException::class)
66 @PreAuthorize("hasRole('USER')")
67 fun bootstrap(@RequestBody bootstrapRequest: BootstrapRequest): Mono<Unit> = monoMdc {
68 bluePrintModelHandler.bootstrapBlueprint(bootstrapRequest)
71 @PostMapping("", produces = [MediaType.APPLICATION_JSON_VALUE], consumes = [MediaType.MULTIPART_FORM_DATA_VALUE])
73 @Throws(BluePrintException::class)
74 @PreAuthorize("hasRole('USER')")
75 fun saveBlueprint(@RequestPart("file") filePart: FilePart): Mono<BlueprintModelSearch> = monoMdc {
76 bluePrintModelHandler.saveBlueprintModel(filePart)
79 @GetMapping("", produces = [MediaType.APPLICATION_JSON_VALUE])
81 @PreAuthorize("hasRole('USER')")
82 fun allBlueprintModel(): List<BlueprintModelSearch> {
83 return this.bluePrintModelHandler.allBlueprintModel()
86 @GetMapping("/paged", produces = [MediaType.APPLICATION_JSON_VALUE])
88 @PreAuthorize("hasRole('USER')")
89 fun allBlueprintModel(
90 @RequestParam(defaultValue = "20") limit: Int,
91 @RequestParam(defaultValue = "0") offset: Int,
92 @RequestParam(defaultValue = "DATE") sort: BlueprintSortByOption
93 ): Page<BlueprintModelSearch> {
94 val pageRequest = PageRequest.of(offset, limit, Sort.Direction.ASC, sort.columnName)
95 return this.bluePrintModelHandler.allBlueprintModel(pageRequest)
98 @GetMapping("meta-data/{keyword}", produces = [MediaType.APPLICATION_JSON_VALUE])
100 @PreAuthorize("hasRole('USER')")
101 fun allBlueprintModelMetaData(@NotNull @PathVariable(value = "keyword") keyWord: String): List<BlueprintModelSearch> {
102 return this.bluePrintModelHandler.searchBluePrintModelsByKeyWord(keyWord)
105 @GetMapping("/paged/meta-data/{keyword}", produces = [MediaType.APPLICATION_JSON_VALUE])
107 @PreAuthorize("hasRole('USER')")
108 fun allBlueprintModelMetaDataPaged(
109 @NotNull @PathVariable(value = "keyword") keyWord: String,
110 @RequestParam(defaultValue = "20") limit: Int,
111 @RequestParam(defaultValue = "0") offset: Int,
112 @RequestParam(defaultValue = "DATE") sort: BlueprintSortByOption
113 ): Page<BlueprintModelSearch> {
114 val pageRequest = PageRequest.of(offset, limit, Sort.Direction.ASC, sort.columnName)
115 return this.bluePrintModelHandler.searchBluePrintModelsByKeyWordPaged(keyWord, pageRequest)
118 @DeleteMapping("/{id}")
119 @Throws(BluePrintException::class)
120 @PreAuthorize("hasRole('USER')")
121 fun deleteBlueprint(@PathVariable(value = "id") id: String) {
122 this.bluePrintModelHandler.deleteBlueprintModel(id)
125 @GetMapping("/by-name/{name}/version/{version}", produces = [MediaType.APPLICATION_JSON_VALUE])
127 @Throws(BluePrintException::class)
128 @PreAuthorize("hasRole('USER')")
129 fun getBlueprintByNameAndVersion(
130 @PathVariable(value = "name") name: String,
131 @PathVariable(value = "version") version: String
133 Mono<ResponseEntity<BlueprintModelSearch>> = monoMdc {
134 var bluePrintModel: BlueprintModelSearch? = bluePrintModelHandler.getBlueprintModelSearchByNameAndVersion(name, version)
135 if (bluePrintModel != null)
136 ResponseEntity(bluePrintModel, HttpStatus.OK)
138 ResponseEntity(HttpStatus.NO_CONTENT)
141 @GetMapping("/download/by-name/{name}/version/{version}", produces = [MediaType.APPLICATION_JSON_VALUE])
143 @Throws(BluePrintException::class)
144 @PreAuthorize("hasRole('USER')")
145 fun downloadBlueprintByNameAndVersion(
146 @PathVariable(value = "name") name: String,
147 @PathVariable(value = "version") version: String
149 Mono<ResponseEntity<Resource>> = monoMdc {
150 bluePrintModelHandler.downloadBlueprintModelFileByNameAndVersion(name, version)
153 @GetMapping("/{id}", produces = [MediaType.APPLICATION_JSON_VALUE])
155 @Throws(BluePrintException::class)
156 @PreAuthorize("hasRole('USER')")
157 fun getBlueprintModel(@PathVariable(value = "id") id: String): BlueprintModelSearch {
158 return this.bluePrintModelHandler.getBlueprintModelSearch(id)
161 @GetMapping("/download/{id}", produces = [MediaType.APPLICATION_JSON_VALUE])
163 @Throws(BluePrintException::class)
164 @PreAuthorize("hasRole('USER')")
165 fun downloadBluePrint(@PathVariable(value = "id") id: String): Mono<ResponseEntity<Resource>> = monoMdc {
166 bluePrintModelHandler.downloadBlueprintModelFile(id)
170 "/enrich", produces = [MediaType.APPLICATION_JSON_VALUE], consumes = [MediaType
171 .MULTIPART_FORM_DATA_VALUE]
174 @Throws(BluePrintException::class)
175 @PreAuthorize("hasRole('USER')")
176 fun enrichBlueprint(@RequestPart("file") file: FilePart): Mono<ResponseEntity<Resource>> = monoMdc {
177 bluePrintModelHandler.enrichBlueprint(file)
180 @PostMapping("/publish", produces = [MediaType.APPLICATION_JSON_VALUE])
182 @Throws(BluePrintException::class)
183 @PreAuthorize("hasRole('USER')")
184 fun publishBlueprint(@RequestPart("file") file: FilePart): Mono<BlueprintModelSearch> = monoMdc {
185 bluePrintModelHandler.publishBlueprint(file)
188 @GetMapping("/search/{tags}", produces = [MediaType.APPLICATION_JSON_VALUE])
190 @PreAuthorize("hasRole('USER')")
191 fun searchBlueprintModels(@PathVariable(value = "tags") tags: String): List<BlueprintModelSearch> {
192 return this.bluePrintModelHandler.searchBlueprintModels(tags)
195 @DeleteMapping("/name/{name}/version/{version}")
197 value = "Delete a CBA",
198 notes = "Delete the CBA package identified by its name and version.",
199 produces = MediaType.APPLICATION_JSON_VALUE
201 @PreAuthorize("hasRole('USER')")
203 @ApiParam(value = "Name of the CBA.", required = true)
204 @PathVariable(value = "name") name: String,
205 @ApiParam(value = "Version of the CBA.", required = true)
206 @PathVariable(value = "version") version: String
208 bluePrintModelHandler.deleteBlueprintModel(name, version)