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.KeyIdentifier
31 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
32 import org.slf4j.LoggerFactory
33 import org.springframework.beans.factory.config.ConfigurableBeanFactory
34 import org.springframework.context.annotation.Scope
35 import org.springframework.stereotype.Service
38 * RestResourceResolutionProcessor
40 * @author Kapil Singal
42 @Service("${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest")
43 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
44 open class RestResourceResolutionProcessor(private val blueprintRestLibPropertyService: BluePrintRestLibPropertyService) :
45 ResourceAssignmentProcessor() {
47 private val logger = LoggerFactory.getLogger(RestResourceResolutionProcessor::class.java)
49 override fun getName(): String {
50 return "${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest"
53 override suspend fun processNB(resourceAssignment: ResourceAssignment) {
55 validate(resourceAssignment)
57 // Check if It has Input
58 if (!setFromInput(resourceAssignment)) {
59 val dName = resourceAssignment.dictionaryName!!
60 val dSource = resourceAssignment.dictionarySource!!
61 val resourceDefinition = resourceDefinition(dName)
63 /** Check Resource Assignment has the source definitions, If not get from Resource Definitions **/
64 val resourceSource = resourceAssignment.dictionarySourceDefinition
65 ?: resourceDefinition?.sources?.get(dSource)
66 ?: throw BluePrintProcessorException("couldn't get resource definition $dName source($dSource)")
68 val resourceSourceProperties =
69 checkNotNull(resourceSource.properties) { "failed to get source properties for $dName " }
71 val sourceProperties =
72 JacksonUtils.getInstanceFromMap(resourceSourceProperties, RestResourceSource::class.java)
74 val path = nullToEmpty(sourceProperties.path)
76 checkNotNull(sourceProperties.inputKeyMapping) { "failed to get input-key-mappings for $dName under $dSource properties" }
77 val resolvedInputKeyMapping = resolveInputKeyMappingVariables(inputKeyMapping).toMutableMap()
79 sourceProperties.inputKeyMapping
80 ?.mapValues { raRuntimeService.getDictionaryStore(it.value) }
81 ?.map { KeyIdentifier(it.key, it.value) }
82 ?.let { resourceAssignment.keyIdentifiers.addAll(it) }
84 // Resolving content Variables
85 val payload = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.payload), resolvedInputKeyMapping)
86 resourceSourceProperties["resolved-payload"] = JacksonUtils.jsonNode(payload)
88 resolveFromInputKeyMapping(checkNotNull(sourceProperties.urlPath), resolvedInputKeyMapping)
89 val verb = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.verb), resolvedInputKeyMapping)
92 "RestResource ($dSource) dictionary information: " +
93 "URL:($urlPath), input-key-mapping:($inputKeyMapping), output-key-mapping:(${sourceProperties.outputKeyMapping})"
95 val requestHeaders = sourceProperties.headers
96 logger.info("$dSource dictionary information : ($urlPath), ($inputKeyMapping), (${sourceProperties.outputKeyMapping})")
97 // Get the Rest Client Service
98 val restClientService = blueprintWebClientService(resourceAssignment, sourceProperties)
100 val response = restClientService.exchangeResource(verb, urlPath, payload, requestHeaders.toMap())
101 val responseStatusCode = response.status
102 val responseBody = response.body
103 val outputKeyMapping = sourceProperties.outputKeyMapping
104 if (responseStatusCode in 200..299 && outputKeyMapping.isNullOrEmpty()) {
105 logger.info("AS>> outputKeyMapping==null, will not populateResource")
106 } else if (responseStatusCode in 200..299 && !responseBody.isBlank()) {
107 populateResource(resourceAssignment, sourceProperties, responseBody, path)
110 "Failed to get $dSource result for dictionary name ($dName) using urlPath ($urlPath) response_code: ($responseStatusCode)"
112 throw BluePrintProcessorException(errMsg)
115 // Check the value has populated for mandatory case
116 ResourceAssignmentUtils.assertTemplateKeyValueNotNull(resourceAssignment)
117 } catch (e: Exception) {
118 ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, e.message)
119 throw BluePrintProcessorException("Failed in template key ($resourceAssignment) assignments with: ${e.message}", e)
123 fun blueprintWebClientService(
124 resourceAssignment: ResourceAssignment,
125 restResourceSource: RestResourceSource
126 ): BlueprintWebClientService {
127 return if (isNotEmpty(restResourceSource.endpointSelector)) {
128 val restPropertiesJson = raRuntimeService.resolveDSLExpression(restResourceSource.endpointSelector!!)
129 blueprintRestLibPropertyService.blueprintWebClientService(restPropertiesJson)
131 blueprintRestLibPropertyService.blueprintWebClientService(resourceAssignment.dictionarySource!!)
135 @Throws(BluePrintProcessorException::class)
136 private fun populateResource(
137 resourceAssignment: ResourceAssignment,
138 sourceProperties: RestResourceSource,
139 restResponse: String,
142 val dName = resourceAssignment.dictionaryName
143 val dSource = resourceAssignment.dictionarySource
144 val type = nullToEmpty(resourceAssignment.property?.type)
145 val metadata = resourceAssignment.property!!.metadata
147 val outputKeyMapping = checkNotNull(sourceProperties.outputKeyMapping) {
148 "failed to get output-key-mappings for $dName under $dSource properties"
150 logger.info("Response processing type ($type)")
152 val responseNode = checkNotNull(JacksonUtils.jsonNode(restResponse).at(path)) {
153 "Failed to find path ($path) in response ($restResponse)"
156 val valueToPrint = ResourceAssignmentUtils.getValueToLog(metadata, responseNode)
157 logger.info("populating value for output mapping ($outputKeyMapping), from json ($valueToPrint)")
159 val parsedResponseNode = ResourceAssignmentUtils.parseResponseNode(
160 responseNode, resourceAssignment,
161 raRuntimeService, outputKeyMapping
164 // Set the List of Complex Values
165 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, parsedResponseNode)
168 @Throws(BluePrintProcessorException::class)
169 private fun validate(resourceAssignment: ResourceAssignment) {
170 checkNotEmpty(resourceAssignment.name) { "resource assignment template key is not defined" }
171 checkNotEmpty(resourceAssignment.dictionaryName) {
172 "resource assignment dictionary name is not defined for template key (${resourceAssignment.name})"
174 checkNotEmpty(resourceAssignment.dictionarySource) {
175 "resource assignment dictionary source is not defined for template key (${resourceAssignment.name})"
179 override suspend fun recoverNB(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
180 raRuntimeService.getBluePrintError().addError(runtimeException.message!!)