ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ResourceController.kt

   1 /*
   2  * Copyright © 2019 Bell Canada
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 package org.onap.ccsdk.cds.blueprintsprocessor.resource.api
  18
  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.ResourceResolution
  25 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.db.ResourceResolutionDBService
  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.RequestMapping
  33 import org.springframework.web.bind.annotation.RequestMethod
  34 import org.springframework.web.bind.annotation.RequestParam
  35 import org.springframework.web.bind.annotation.ResponseBody
  36 import org.springframework.web.bind.annotation.RestController
  37
  38 @RestController
  39 @RequestMapping("/api/v1/resources")
  40 @Api(
  41     value = "Resources",
  42     description = "Interaction with resolved resources."
  43 )
  44 open class ResourceController(private var resourceResolutionDBService: ResourceResolutionDBService) {
  45
  46     @RequestMapping(
  47         path = ["/health-check"],
  48         method = [RequestMethod.GET],
  49         produces = [MediaType.APPLICATION_JSON_VALUE]
  50     )
  51     @ResponseBody
  52     @ApiOperation(value = "Health Check", hidden = true)
  53     fun resourceControllerHealthCheck(): JsonNode = runBlocking {
  54         JacksonUtils.getJsonNode("Success")
  55     }
  56
  57     @RequestMapping(
  58         path = [""],
  59         method = [RequestMethod.GET], produces = [MediaType.APPLICATION_JSON_VALUE]
  60     )
  61     @ApiOperation(
  62         value = "Get all resolved resources using the resolution key. ",
  63         notes = "Retrieve all stored resolved resources using the blueprint name, blueprint version, " +
  64             "artifact name and the resolution-key.",
  65         response = ResourceResolution::class,
  66         responseContainer = "List",
  67         produces = MediaType.APPLICATION_JSON_VALUE
  68     )
  69     @ResponseBody
  70     @PreAuthorize("hasRole('USER')")
  71     fun getAllFromResolutionKeyOrFromResourceTypeAndId(
  72         @ApiParam(value = "Name of the CBA.", required = true)
  73         @RequestParam(value = "bpName", required = true) bpName: String,
  74         @ApiParam(value = "Version of the CBA.", required = true)
  75         @RequestParam(value = "bpVersion", required = true) bpVersion: String,
  76         @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
  77         @RequestParam(value = "artifactName", required = false, defaultValue = "") artifactName: String,
  78         @ApiParam(value = "Resolution Key associated with the resolution.", required = false)
  79         @RequestParam(value = "resolutionKey", required = false, defaultValue = "") resolutionKey: String,
  80         @ApiParam(value = "Resource Type associated with the resolution.", required = false)
  81         @RequestParam(value = "resourceType", required = false, defaultValue = "") resourceType: String,
  82         @ApiParam(value = "Resource Id associated with the resolution.", required = false)
  83         @RequestParam(value = "resourceId", required = false, defaultValue = "") resourceId: String
  84     ):
  85         ResponseEntity<List<ResourceResolution>> = runBlocking {
  86
  87             if ((resolutionKey.isNotEmpty() || artifactName.isNotEmpty()) && (resourceId.isNotEmpty() || resourceType.isNotEmpty())) {
  88                 throw httpProcessorException(
  89                     ErrorCatalogCodes.REQUEST_NOT_FOUND, ResourceApiDomains.RESOURCE_API,
  90                     "Either retrieve resolved value using artifact name and resolution-key OR using resource-id and resource-type."
  91                 )
  92             } else if (resolutionKey.isNotEmpty() && artifactName.isNotEmpty()) {
  93                 ResponseEntity.ok()
  94                     .body(resourceResolutionDBService.readWithResolutionKey(bpName, bpVersion, artifactName, resolutionKey))
  95             } else if (resourceType.isNotEmpty() && resourceId.isNotEmpty()) {
  96                 ResponseEntity.ok()
  97                     .body(
  98                         resourceResolutionDBService.readWithResourceIdAndResourceType(
  99                             bpName,
 100                             bpVersion,
 101                             resourceId,
 102                             resourceType
 103                         )
 104                     )
 105             } else {
 106                 throw httpProcessorException(
 107                     ErrorCatalogCodes.REQUEST_NOT_FOUND, ResourceApiDomains.RESOURCE_API,
 108                     "Missing param. Either retrieve resolved value using artifact name and resolution-key OR using resource-id and resource-type."
 109                 )
 110             }
 111         }
 112
 113     @RequestMapping(
 114         path = [""],
 115         method = [RequestMethod.DELETE], produces = [MediaType.APPLICATION_JSON_VALUE]
 116     )
 117     @ApiOperation(
 118         value = "Delete resources using resolution key",
 119         notes = "Delete all the resources associated to a resolution-key using blueprint metadata, artifact name and the resolution-key."
 120     )
 121     @PreAuthorize("hasRole('USER')")
 122     fun deleteByBlueprintNameAndBlueprintVersionAndArtifactNameAndResolutionKey(
 123         @ApiParam(value = "Name of the CBA.", required = true)
 124         @RequestParam(value = "bpName", required = true) bpName: String,
 125         @ApiParam(value = "Version of the CBA.", required = true)
 126         @RequestParam(value = "bpVersion", required = true) bpVersion: String,
 127         @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
 128         @RequestParam(value = "artifactName", required = false, defaultValue = "") artifactName: String,
 129         @ApiParam(value = "Resolution Key associated with the resolution.", required = true)
 130         @RequestParam(value = "resolutionKey", required = true) resolutionKey: String
 131     ) = runBlocking {
 132         ResponseEntity.ok()
 133             .body(
 134                 resourceResolutionDBService.deleteByBlueprintNameAndBlueprintVersionAndArtifactNameAndResolutionKey(
 135                     bpName,
 136                     bpVersion,
 137                     artifactName,
 138                     resolutionKey
 139                 )
 140             )
 141     }
 142
 143     @RequestMapping(
 144         path = ["/resource"],
 145         method = [RequestMethod.GET],
 146         produces = [MediaType.APPLICATION_JSON_VALUE]
 147     )
 148     @ApiOperation(
 149         value = "Fetch a resource value using resolution key.",
 150         notes = "Retrieve a stored resource value using the blueprint metadata, artifact name, resolution-key along with the name of the resource value to retrieve."
 151     )
 152     @ResponseBody
 153     @PreAuthorize("hasRole('USER')")
 154     fun getOneFromResolutionKey(
 155         @ApiParam(value = "Name of the CBA.", required = true)
 156         @RequestParam(value = "bpName", required = true) bpName: String,
 157         @ApiParam(value = "Version of the CBA.", required = true)
 158         @RequestParam(value = "bpVersion", required = true) bpVersion: String,
 159         @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
 160         @RequestParam(value = "artifactName", required = true) artifactName: String,
 161         @ApiParam(value = "Resolution Key associated with the resolution.", required = true)
 162         @RequestParam(value = "resolutionKey", required = true) resolutionKey: String,
 163         @ApiParam(value = "Name of the resource to retrieve.", required = true)
 164         @RequestParam(value = "name", required = true) name: String
 165     ):
 166         ResponseEntity<ResourceResolution> = runBlocking {
 167
 168             ResponseEntity.ok()
 169                 .body(resourceResolutionDBService.readValue(bpName, bpVersion, artifactName, resolutionKey, name))
 170         }
 171 }