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 com.fasterxml.jackson.databind.node.ArrayNode
21 import com.fasterxml.jackson.databind.node.MissingNode
22 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR
23 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.RestResourceSource
24 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
25 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BluePrintRestLibPropertyService
26 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BlueprintWebClientService
27 import org.onap.ccsdk.cds.controllerblueprints.core.*
28 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
29 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
30 import org.slf4j.LoggerFactory
31 import org.springframework.beans.factory.config.ConfigurableBeanFactory
32 import org.springframework.context.annotation.Scope
33 import org.springframework.stereotype.Service
36 * RestResourceResolutionProcessor
38 * @author Kapil Singal
40 @Service("${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest")
41 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
42 open class RestResourceResolutionProcessor(private val blueprintRestLibPropertyService: BluePrintRestLibPropertyService)
43 : ResourceAssignmentProcessor() {
45 private val logger = LoggerFactory.getLogger(RestResourceResolutionProcessor::class.java)
47 override fun getName(): String {
48 return "${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest"
51 override suspend fun processNB(resourceAssignment: ResourceAssignment) {
53 validate(resourceAssignment)
55 // Check if It has Input
56 val value = getFromInput(resourceAssignment)
57 if (value == null || value is MissingNode) {
58 val dName = resourceAssignment.dictionaryName
59 val dSource = resourceAssignment.dictionarySource
60 val resourceDefinition = resourceDictionaries[dName]
61 ?: throw BluePrintProcessorException("couldn't get resource dictionary definition for $dName")
63 val resourceSource = resourceDefinition.sources[dSource]
64 ?: throw BluePrintProcessorException("couldn't get resource definition $dName source($dSource)")
66 val resourceSourceProperties =
67 checkNotNull(resourceSource.properties) { "failed to get source properties for $dName " }
69 val sourceProperties =
70 JacksonUtils.getInstanceFromMap(resourceSourceProperties, RestResourceSource::class.java)
72 val path = nullToEmpty(sourceProperties.path)
74 checkNotNull(sourceProperties.inputKeyMapping) { "failed to get input-key-mappings for $dName under $dSource properties" }
75 val resolvedInputKeyMapping = resolveInputKeyMappingVariables(inputKeyMapping).toMutableMap()
77 // Resolving content Variables
78 val payload = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.payload), resolvedInputKeyMapping)
80 resolveFromInputKeyMapping(checkNotNull(sourceProperties.urlPath), resolvedInputKeyMapping)
81 val verb = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.verb), resolvedInputKeyMapping)
83 logger.info("$dSource dictionary information : ($urlPath), ($inputKeyMapping), (${sourceProperties.outputKeyMapping})")
84 // Get the Rest Client Service
85 val restClientService = blueprintWebClientService(resourceAssignment, sourceProperties)
87 val response = restClientService.exchangeResource(verb, urlPath, payload)
88 val responseStatusCode = response.status
89 val responseBody = response.body
90 if (responseStatusCode in 200..299 && !responseBody.isBlank()) {
91 populateResource(resourceAssignment, sourceProperties, responseBody, path)
93 val errMsg = "Failed to get $dSource result for dictionary name ($dName) using urlPath ($urlPath) response_code: ($responseStatusCode)"
95 throw BluePrintProcessorException(errMsg)
98 // Check the value has populated for mandatory case
99 ResourceAssignmentUtils.assertTemplateKeyValueNotNull(resourceAssignment)
100 } catch (e: Exception) {
101 ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, e.message)
102 throw BluePrintProcessorException("Failed in template key ($resourceAssignment) assignments with: ${e.message}",
107 fun blueprintWebClientService(resourceAssignment: ResourceAssignment,
108 restResourceSource: RestResourceSource): BlueprintWebClientService {
109 return if (isNotEmpty(restResourceSource.endpointSelector)) {
110 val restPropertiesJson = raRuntimeService.resolveDSLExpression(restResourceSource.endpointSelector!!)
111 blueprintRestLibPropertyService.blueprintWebClientService(restPropertiesJson)
113 blueprintRestLibPropertyService.blueprintWebClientService(resourceAssignment.dictionarySource!!)
117 @Throws(BluePrintProcessorException::class)
118 private fun populateResource(resourceAssignment: ResourceAssignment, sourceProperties: RestResourceSource,
119 restResponse: String, path: String) {
120 val dName = resourceAssignment.dictionaryName
121 val dSource = resourceAssignment.dictionarySource
122 val type = nullToEmpty(resourceAssignment.property?.type)
123 lateinit var entrySchemaType: String
125 val outputKeyMapping = checkNotNull(sourceProperties.outputKeyMapping) {
126 "failed to get output-key-mappings for $dName under $dSource properties"
128 logger.info("Response processing type($type)")
130 val responseNode = checkNotNull(JacksonUtils.jsonNode(restResponse).at(path)) {
131 "Failed to find path ($path) in response ($restResponse)"
133 logger.info("populating value for output mapping ($outputKeyMapping), from json ($responseNode)")
137 in BluePrintTypes.validPrimitiveTypes() -> {
138 logger.info("For template key (${resourceAssignment.name}) setting value as ($responseNode)")
139 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, responseNode)
141 in BluePrintTypes.validCollectionTypes() -> {
143 entrySchemaType = checkNotEmpty(resourceAssignment.property?.entrySchema?.type) {
144 "Entry schema is not defined for dictionary ($dName) info"
146 val arrayNode = responseNode as ArrayNode
148 if (entrySchemaType !in BluePrintTypes.validPrimitiveTypes()) {
150 val responseArrayNode = responseNode.toList()
151 for (responseSingleJsonNode in responseArrayNode) {
153 val arrayChildNode = JacksonUtils.objectMapper.createObjectNode()
155 outputKeyMapping.map {
156 val responseKeyValue = responseSingleJsonNode.get(it.key)
157 val propertyTypeForDataType = ResourceAssignmentUtils
158 .getPropertyType(raRuntimeService, entrySchemaType, it.key)
160 logger.info("For List Type Resource: key (${it.key}), value ($responseKeyValue), " +
161 "type ({$propertyTypeForDataType})")
163 JacksonUtils.populateJsonNodeValues(it.value,
164 responseKeyValue, propertyTypeForDataType, arrayChildNode)
166 arrayNode.add(arrayChildNode)
169 logger.info("For template key (${resourceAssignment.name}) setting value as ($arrayNode)")
170 // Set the List of Complex Values
171 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, arrayNode)
175 entrySchemaType = checkNotEmpty(resourceAssignment.property?.type) {
176 "Entry schema is not defined for dictionary ($dName) info"
178 val objectNode = JacksonUtils.objectMapper.createObjectNode()
179 outputKeyMapping.map {
180 val responseKeyValue = responseNode.get(it.key)
181 val propertyTypeForDataType = ResourceAssignmentUtils
182 .getPropertyType(raRuntimeService, entrySchemaType, it.key)
184 logger.info("For List Type Resource: key (${it.key}), value ($responseKeyValue), type ({$propertyTypeForDataType})")
185 JacksonUtils.populateJsonNodeValues(it.value, responseKeyValue, propertyTypeForDataType, objectNode)
188 logger.info("For template key (${resourceAssignment.name}) setting value as ($objectNode)")
189 // Set the List of Complex Values
190 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, objectNode)
195 @Throws(BluePrintProcessorException::class)
196 private fun validate(resourceAssignment: ResourceAssignment) {
197 checkNotEmpty(resourceAssignment.name) { "resource assignment template key is not defined" }
198 checkNotEmpty(resourceAssignment.dictionaryName) {
199 "resource assignment dictionary name is not defined for template key (${resourceAssignment.name})"
201 checkNotEmpty(resourceAssignment.dictionarySource) {
202 "resource assignment dictionary source is not defined for template key (${resourceAssignment.name})"
206 override suspend fun recoverNB(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
207 raRuntimeService.getBluePrintError().addError(runtimeException.message!!)