2 * Copyright © 2019 Bell Canada
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package org.onap.ccsdk.cds.blueprintsprocessor.resource.api
19 import com.fasterxml.jackson.databind.JsonNode
20 import io.swagger.annotations.Api
21 import io.swagger.annotations.ApiOperation
22 import io.swagger.annotations.ApiParam
23 import kotlinx.coroutines.runBlocking
24 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.db.TemplateResolution
25 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.db.TemplateResolutionService
26 import org.onap.ccsdk.cds.controllerblueprints.core.httpProcessorException
27 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
28 import org.onap.ccsdk.cds.error.catalog.core.ErrorCatalogCodes
29 import org.springframework.http.MediaType
30 import org.springframework.http.ResponseEntity
31 import org.springframework.security.access.prepost.PreAuthorize
32 import org.springframework.web.bind.annotation.PathVariable
33 import org.springframework.web.bind.annotation.PostMapping
34 import org.springframework.web.bind.annotation.RequestBody
35 import org.springframework.web.bind.annotation.RequestMapping
36 import org.springframework.web.bind.annotation.RequestMethod
37 import org.springframework.web.bind.annotation.RequestParam
38 import org.springframework.web.bind.annotation.ResponseBody
39 import org.springframework.web.bind.annotation.RestController
42 * Exposes Template Resolution API to store and retrieve rendered template results.
44 * @author Serge Simard
48 @RequestMapping("/api/v1/template")
50 value = "Resource template",
51 description = "Interaction with resolved template."
53 open class TemplateController(private val templateResolutionService: TemplateResolutionService) {
56 path = ["/health-check"],
57 method = [RequestMethod.GET],
58 produces = [MediaType.APPLICATION_JSON_VALUE]
61 @ApiOperation(value = "Health Check", hidden = true)
62 fun templateControllerHealthCheck(): JsonNode = runBlocking {
63 JacksonUtils.getJsonNode("Success")
68 method = [RequestMethod.GET],
69 produces = [MediaType.TEXT_PLAIN_VALUE, MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE]
72 value = "Retrieve a resolved template.",
73 notes = "Retrieve a config template for a given CBA's action, identified by its blueprint name, blueprint version, " +
74 "artifact name and resolution key. An extra 'format' parameter can be passed to tell what content-type" +
75 " to expect in return"
78 @PreAuthorize("hasRole('USER')")
80 @ApiParam(value = "Name of the CBA.", required = true)
81 @RequestParam(value = "bpName") bpName: String,
82 @ApiParam(value = "Version of the CBA.", required = true)
83 @RequestParam(value = "bpVersion") bpVersion: String,
84 @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
85 @RequestParam(value = "artifactName") artifactName: String,
86 @ApiParam(value = "Resolution Key associated with the resolution.", required = false)
87 @RequestParam(value = "resolutionKey") resolutionKey: String,
88 @ApiParam(value = "Resource Type associated with the resolution.", required = false)
89 @RequestParam(value = "resourceType", required = false, defaultValue = "") resourceType: String,
90 @ApiParam(value = "Resource Id associated with the resolution.", required = false)
91 @RequestParam(value = "resourceId", required = false, defaultValue = "") resourceId: String,
93 value = "Expected format of the template being retrieved.",
94 defaultValue = MediaType.TEXT_PLAIN_VALUE,
97 @RequestParam(value = "format", required = false, defaultValue = MediaType.TEXT_PLAIN_VALUE) format: String,
98 @ApiParam(value = "Occurrence of the template resolution (1-n).", required = false)
99 @RequestParam(value = "occurrence", required = false, defaultValue = "1") occurrence: Int = 1
101 ResponseEntity<String> = runBlocking {
105 if ((resolutionKey.isNotEmpty() || artifactName.isNotEmpty()) && (resourceId.isNotEmpty() || resourceType.isNotEmpty())) {
106 throw httpProcessorException(
107 ErrorCatalogCodes.REQUEST_NOT_FOUND, ResourceApiDomains.RESOURCE_API,
108 "Either retrieve resolved template using artifact name and resolution-key OR using resource-id and resource-type."
110 } else if (resolutionKey.isNotEmpty() && artifactName.isNotEmpty()) {
111 result = templateResolutionService.findByResolutionKeyAndBlueprintNameAndBlueprintVersionAndArtifactName(
118 } else if (resourceType.isNotEmpty() && resourceId.isNotEmpty()) {
120 templateResolutionService.findByResoureIdAndResourceTypeAndBlueprintNameAndBlueprintVersionAndArtifactName(
129 throw httpProcessorException(
130 ErrorCatalogCodes.REQUEST_NOT_FOUND, ResourceApiDomains.RESOURCE_API,
131 "Missing param. Either retrieve resolved template using artifact name and resolution-key OR using resource-id and resource-type."
135 var expectedContentType = format
136 if (expectedContentType.indexOf('/') < 0) {
137 expectedContentType = "application/$expectedContentType"
139 val expectedMediaType: MediaType = MediaType.valueOf(expectedContentType)
141 ResponseEntity.ok().contentType(expectedMediaType).body(result)
144 @PostMapping("/{bpName}/{bpVersion}/{artifactName}/{resolutionKey}", produces = [MediaType.APPLICATION_JSON_VALUE])
146 value = "Store a resolved template w/ resolution-key",
147 notes = "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, " +
148 "artifact name and resolution key.",
149 response = TemplateResolution::class
152 @PreAuthorize("hasRole('USER')")
153 fun postWithResolutionKey(
154 @ApiParam(value = "Name of the CBA.", required = true)
155 @PathVariable(value = "bpName") bpName: String,
156 @ApiParam(value = "Version of the CBA.", required = true)
157 @PathVariable(value = "bpVersion") bpVersion: String,
158 @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
159 @PathVariable(value = "artifactName") artifactName: String,
160 @ApiParam(value = "Resolution Key associated with the resolution.", required = true)
161 @PathVariable(value = "resolutionKey") resolutionKey: String,
162 @ApiParam(value = "Template to store.", required = true)
163 @RequestBody result: String
164 ): ResponseEntity<TemplateResolution> = runBlocking {
167 templateResolutionService.write(bpName, bpVersion, artifactName, result, resolutionKey = resolutionKey)
169 ResponseEntity.ok().body(resultStored)
173 "/{bpName}/{bpVersion}/{artifactName}/{resourceType}/{resourceId}",
174 produces = [MediaType.APPLICATION_JSON_VALUE]
177 value = "Store a resolved template w/ resourceId and resourceType",
178 notes = "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, " +
179 "artifact name, resourceId and resourceType.",
180 response = TemplateResolution::class
183 @PreAuthorize("hasRole('USER')")
184 fun postWithResourceIdAndResourceType(
185 @ApiParam(value = "Name of the CBA.", required = true)
186 @PathVariable(value = "bpName") bpName: String,
187 @ApiParam(value = "Version of the CBA.", required = true)
188 @PathVariable(value = "bpVersion") bpVersion: String,
189 @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
190 @PathVariable(value = "artifactName") artifactName: String,
191 @ApiParam(value = "Resource Type associated with the resolution.", required = false)
192 @PathVariable(value = "resourceType", required = true) resourceType: String,
193 @ApiParam(value = "Resource Id associated with the resolution.", required = false)
194 @PathVariable(value = "resourceId", required = true) resourceId: String,
195 @ApiParam(value = "Template to store.", required = true)
196 @RequestBody result: String
197 ): ResponseEntity<TemplateResolution> = runBlocking {
200 templateResolutionService.write(bpName, bpVersion, artifactName, result, resourceId = resourceId, resourceType = resourceType)
202 ResponseEntity.ok().body(resultStored)