2 * Copyright © 2018 IBM.
3 * Modifications Copyright © 2017-2019 AT&T, Bell Canada
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor
20 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR
21 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.RestResourceSource
22 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
23 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BluePrintRestLibPropertyService
24 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BlueprintWebClientService
25 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
26 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotEmpty
27 import org.onap.ccsdk.cds.controllerblueprints.core.isNotEmpty
28 import org.onap.ccsdk.cds.controllerblueprints.core.nullToEmpty
29 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
30 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
31 import org.slf4j.LoggerFactory
32 import org.springframework.beans.factory.config.ConfigurableBeanFactory
33 import org.springframework.context.annotation.Scope
34 import org.springframework.stereotype.Service
37 * RestResourceResolutionProcessor
39 * @author Kapil Singal
41 @Service("${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest")
42 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
43 open class RestResourceResolutionProcessor(private val blueprintRestLibPropertyService: BluePrintRestLibPropertyService) :
44 ResourceAssignmentProcessor() {
46 private val logger = LoggerFactory.getLogger(RestResourceResolutionProcessor::class.java)
48 override fun getName(): String {
49 return "${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest"
52 override suspend fun processNB(resourceAssignment: ResourceAssignment) {
54 validate(resourceAssignment)
56 // Check if It has Input
57 if (!setFromInput(resourceAssignment)) {
58 val dName = resourceAssignment.dictionaryName!!
59 val dSource = resourceAssignment.dictionarySource!!
60 val resourceDefinition = resourceDefinition(dName)
62 /** Check Resource Assignment has the source definitions, If not get from Resource Definitions **/
63 val resourceSource = resourceAssignment.dictionarySourceDefinition
64 ?: resourceDefinition?.sources?.get(dSource)
65 ?: throw BluePrintProcessorException("couldn't get resource definition $dName source($dSource)")
67 val resourceSourceProperties =
68 checkNotNull(resourceSource.properties) { "failed to get source properties for $dName " }
70 val sourceProperties =
71 JacksonUtils.getInstanceFromMap(resourceSourceProperties, RestResourceSource::class.java)
73 val path = nullToEmpty(sourceProperties.path)
75 checkNotNull(sourceProperties.inputKeyMapping) { "failed to get input-key-mappings for $dName under $dSource properties" }
76 val resolvedInputKeyMapping = resolveInputKeyMappingVariables(inputKeyMapping).toMutableMap()
78 // Resolving content Variables
79 val payload = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.payload), resolvedInputKeyMapping)
81 resolveFromInputKeyMapping(checkNotNull(sourceProperties.urlPath), resolvedInputKeyMapping)
82 val verb = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.verb), resolvedInputKeyMapping)
84 logger.info("RestResource ($dSource) dictionary information: " +
85 "URL:($urlPath), input-key-mapping:($inputKeyMapping), output-key-mapping:(${sourceProperties.outputKeyMapping})")
86 // Get the Rest Client Service
87 val restClientService = blueprintWebClientService(resourceAssignment, sourceProperties)
89 val response = restClientService.exchangeResource(verb, urlPath, payload)
90 val responseStatusCode = response.status
91 val responseBody = response.body
92 val outputKeyMapping = sourceProperties.outputKeyMapping
93 if (responseStatusCode in 200..299 && outputKeyMapping.isNullOrEmpty()) {
94 logger.info("AS>> outputKeyMapping==null, will not populateResource")
95 } else if (responseStatusCode in 200..299 && !responseBody.isBlank()) {
96 populateResource(resourceAssignment, sourceProperties, responseBody, path)
99 "Failed to get $dSource result for dictionary name ($dName) using urlPath ($urlPath) response_code: ($responseStatusCode)"
101 throw BluePrintProcessorException(errMsg)
104 // Check the value has populated for mandatory case
105 ResourceAssignmentUtils.assertTemplateKeyValueNotNull(resourceAssignment)
106 } catch (e: Exception) {
107 ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, e.message)
108 throw BluePrintProcessorException("Failed in template key ($resourceAssignment) assignments with: ${e.message}", e)
112 fun blueprintWebClientService(
113 resourceAssignment: ResourceAssignment,
114 restResourceSource: RestResourceSource
115 ): BlueprintWebClientService {
116 return if (isNotEmpty(restResourceSource.endpointSelector)) {
117 val restPropertiesJson = raRuntimeService.resolveDSLExpression(restResourceSource.endpointSelector!!)
118 blueprintRestLibPropertyService.blueprintWebClientService(restPropertiesJson)
120 blueprintRestLibPropertyService.blueprintWebClientService(resourceAssignment.dictionarySource!!)
124 @Throws(BluePrintProcessorException::class)
125 private fun populateResource(
126 resourceAssignment: ResourceAssignment, sourceProperties: RestResourceSource,
127 restResponse: String, path: String
129 val dName = resourceAssignment.dictionaryName
130 val dSource = resourceAssignment.dictionarySource
131 val type = nullToEmpty(resourceAssignment.property?.type)
132 val metadata = resourceAssignment.property!!.metadata
134 val outputKeyMapping = checkNotNull(sourceProperties.outputKeyMapping) {
135 "failed to get output-key-mappings for $dName under $dSource properties"
137 logger.info("Response processing type ($type)")
139 val responseNode = checkNotNull(JacksonUtils.jsonNode(restResponse).at(path)) {
140 "Failed to find path ($path) in response ($restResponse)"
143 val valueToPrint = ResourceAssignmentUtils.getValueToLog(metadata, responseNode)
144 logger.info("populating value for output mapping ($outputKeyMapping), from json ($valueToPrint)")
146 val parsedResponseNode = ResourceAssignmentUtils.parseResponseNode(
147 responseNode, resourceAssignment,
148 raRuntimeService, outputKeyMapping
151 // Set the List of Complex Values
152 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, parsedResponseNode)
155 @Throws(BluePrintProcessorException::class)
156 private fun validate(resourceAssignment: ResourceAssignment) {
157 checkNotEmpty(resourceAssignment.name) { "resource assignment template key is not defined" }
158 checkNotEmpty(resourceAssignment.dictionaryName) {
159 "resource assignment dictionary name is not defined for template key (${resourceAssignment.name})"
161 checkNotEmpty(resourceAssignment.dictionarySource) {
162 "resource assignment dictionary source is not defined for template key (${resourceAssignment.name})"
166 override suspend fun recoverNB(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
167 raRuntimeService.getBluePrintError().addError(runtimeException.message!!)