2 * Copyright © 2018 - 2020 IBM.
3 * Modifications Copyright © 2017-2020 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.blueprintsprocessor.services.execution.ExecutionServiceDomains
26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
27 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
28 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotEmpty
29 import org.onap.ccsdk.cds.controllerblueprints.core.isNotEmpty
30 import org.onap.ccsdk.cds.controllerblueprints.core.nullToEmpty
31 import org.onap.ccsdk.cds.controllerblueprints.core.updateErrorMessage
32 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
33 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.KeyIdentifier
34 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
35 import org.slf4j.LoggerFactory
36 import org.springframework.beans.factory.config.ConfigurableBeanFactory
37 import org.springframework.context.annotation.Scope
38 import org.springframework.stereotype.Service
41 * RestResourceResolutionProcessor
43 * @author Kapil Singal
45 @Service("${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest")
46 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
47 open class RestResourceResolutionProcessor(private val blueprintRestLibPropertyService: BluePrintRestLibPropertyService) :
48 ResourceAssignmentProcessor() {
50 private val logger = LoggerFactory.getLogger(RestResourceResolutionProcessor::class.java)
52 override fun getName(): String {
53 return "${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest"
56 override suspend fun processNB(resourceAssignment: ResourceAssignment) {
58 validate(resourceAssignment)
60 // Check if It has Input
61 if (!setFromInput(resourceAssignment)) {
62 val dName = resourceAssignment.dictionaryName!!
63 val dSource = resourceAssignment.dictionarySource!!
64 val resourceDefinition = resourceDefinition(dName)
66 /** Check Resource Assignment has the source definitions, If not get from Resource Definitions **/
67 val resourceSource = resourceAssignment.dictionarySourceDefinition
68 ?: resourceDefinition?.sources?.get(dSource)
69 ?: throw BluePrintProcessorException("couldn't get resource definition $dName source($dSource)")
71 val resourceSourceProperties =
72 checkNotNull(resourceSource.properties) { "failed to get source properties for $dName " }
74 val sourceProperties =
75 JacksonUtils.getInstanceFromMap(resourceSourceProperties, RestResourceSource::class.java)
78 checkNotNull(sourceProperties.inputKeyMapping) { "failed to get input-key-mappings for $dName under $dSource properties" }
79 val resolvedInputKeyMapping = resolveInputKeyMappingVariables(inputKeyMapping).toMutableMap()
81 resolvedInputKeyMapping.map { KeyIdentifier(it.key, it.value) }.let {
82 resourceAssignment.keyIdentifiers.addAll(it)
85 // Resolving content Variables
86 val path = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.path), resolvedInputKeyMapping)
87 val payload = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.payload), resolvedInputKeyMapping)
88 resourceSourceProperties["resolved-payload"] = JacksonUtils.jsonNode(payload)
90 resolveFromInputKeyMapping(checkNotNull(sourceProperties.urlPath), resolvedInputKeyMapping)
91 val verb = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.verb), resolvedInputKeyMapping)
92 var outputKeyMapping = sourceProperties.outputKeyMapping
93 if (!outputKeyMapping.isNullOrEmpty()) {
94 outputKeyMapping = outputKeyMapping.mapValues { (_, value) ->
95 resolveFromInputKeyMapping(value, resolvedInputKeyMapping)
99 "RestResource ($dSource) dictionary information: " +
100 "URL:($urlPath), path:($path), input-key-mapping:($inputKeyMapping), output-key-mapping:($outputKeyMapping)"
102 val requestHeaders = sourceProperties.headers.mapValues { (_, value) ->
103 resolveFromInputKeyMapping(value, resolvedInputKeyMapping)
105 logger.info("$dSource dictionary information : ($urlPath), path:($path), ($inputKeyMapping), ($outputKeyMapping)")
106 // Get the Rest Client Service
107 val restClientService = blueprintWebClientService(resourceAssignment, sourceProperties)
109 val response = restClientService.exchangeResource(verb, urlPath, payload, requestHeaders.toMap())
110 val responseStatusCode = response.status
111 val responseBody = response.body
112 if (responseStatusCode in 200..299 && outputKeyMapping.isNullOrEmpty()) {
113 resourceAssignment.status = BluePrintConstants.STATUS_SUCCESS
114 logger.info("AS>> outputKeyMapping==null, will not populateResource")
115 } else if (responseStatusCode in 200..299 && !responseBody.isBlank()) {
116 populateResource(resourceAssignment, sourceProperties, responseBody, path, outputKeyMapping)
119 "Failed to get $dSource result for dictionary name ($dName) using urlPath ($urlPath) response_code: ($responseStatusCode)"
121 throw BluePrintProcessorException(errMsg)
124 // Check the value has populated for mandatory case
125 ResourceAssignmentUtils.assertTemplateKeyValueNotNull(resourceAssignment)
126 } catch (e: BluePrintProcessorException) {
127 val errorMsg = "Failed to process REST resource resolution in template key ($resourceAssignment) assignments."
128 ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, errorMsg)
129 throw e.updateErrorMessage(
130 ExecutionServiceDomains.RESOURCE_RESOLUTION, errorMsg,
131 "Wrong resource definition or resolution failed."
133 } catch (e: Exception) {
134 ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, e.message)
135 throw BluePrintProcessorException("Failed in template key ($resourceAssignment) assignments with: ${e.message}", e)
139 fun blueprintWebClientService(
140 resourceAssignment: ResourceAssignment,
141 restResourceSource: RestResourceSource
142 ): BlueprintWebClientService {
143 return if (isNotEmpty(restResourceSource.endpointSelector)) {
144 val restPropertiesJson = raRuntimeService.resolveDSLExpression(restResourceSource.endpointSelector!!)
145 blueprintRestLibPropertyService.blueprintWebClientService(restPropertiesJson)
147 blueprintRestLibPropertyService.blueprintWebClientService(resourceAssignment.dictionarySource!!)
151 @Throws(BluePrintProcessorException::class)
152 private fun populateResource(
153 resourceAssignment: ResourceAssignment,
154 sourceProperties: RestResourceSource,
155 restResponse: String,
157 outputKeyMapping: MutableMap<String, String>?
159 val dName = resourceAssignment.dictionaryName
160 val dSource = resourceAssignment.dictionarySource
161 val type = nullToEmpty(resourceAssignment.property?.type)
162 val metadata = resourceAssignment.property!!.metadata
164 val outputKeyMapping = checkNotNull(outputKeyMapping) {
165 "failed to get output-key-mappings for $dName under $dSource properties"
167 logger.info("Response processing type ($type)")
169 val responseNode = checkNotNull(JacksonUtils.jsonNode(restResponse).at(path)) {
170 "Failed to find path ($path) in response ($restResponse)"
173 val valueToPrint = ResourceAssignmentUtils.getValueToLog(metadata, responseNode)
174 logger.info("populating value for output mapping ($outputKeyMapping), from json ($valueToPrint)")
176 val parsedResponseNode = ResourceAssignmentUtils.parseResponseNode(
177 responseNode, resourceAssignment,
178 raRuntimeService, outputKeyMapping
181 // Set the List of Complex Values
182 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, parsedResponseNode)
185 @Throws(BluePrintProcessorException::class)
186 private fun validate(resourceAssignment: ResourceAssignment) {
187 checkNotEmpty(resourceAssignment.name) { "resource assignment template key is not defined" }
188 checkNotEmpty(resourceAssignment.dictionaryName) {
189 "resource assignment dictionary name is not defined for template key (${resourceAssignment.name})"
191 checkNotEmpty(resourceAssignment.dictionarySource) {
192 "resource assignment dictionary source is not defined for template key (${resourceAssignment.name})"
196 override suspend fun recoverNB(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
197 addError(runtimeException.message!!)