2 * Copyright © 2018 IBM.
4 * Modifications Copyright © 2017-2019 AT&T, Bell Canada
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
19 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor
21 import com.fasterxml.jackson.databind.JsonNode
22 import org.apache.commons.collections.MapUtils
23 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceAssignmentRuntimeService
24 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
25 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintException
27 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
28 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonNode
29 import org.onap.ccsdk.cds.controllerblueprints.core.interfaces.BlueprintFunctionNode
30 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintVelocityTemplateService
31 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
32 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceDefinition
33 import org.slf4j.LoggerFactory
36 abstract class ResourceAssignmentProcessor : BlueprintFunctionNode<ResourceAssignment, Boolean> {
38 private val log = LoggerFactory.getLogger(ResourceAssignmentProcessor::class.java)
40 lateinit var raRuntimeService: ResourceAssignmentRuntimeService
41 lateinit var resourceDictionaries: MutableMap<String, ResourceDefinition>
43 var scriptPropertyInstances: MutableMap<String, Any> = hashMapOf()
44 lateinit var scriptType: String
47 * This will be called from the scripts to serve instance from runtime to scripts.
49 open fun <T> scriptPropertyInstanceType(name: String): T {
50 return scriptPropertyInstances as? T
51 ?: throw BluePrintProcessorException("couldn't get script property instance ($name)")
54 open fun getFromInput(resourceAssignment: ResourceAssignment): JsonNode? {
55 var value: JsonNode? = null
57 value = raRuntimeService.getInputValue(resourceAssignment.name)
58 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, value)
59 } catch (e: BluePrintProcessorException) {
60 // NoOp - couldn't find value from input
65 open fun resourceDefinition(name: String): ResourceDefinition {
66 return resourceDictionaries[name]
67 ?: throw BluePrintProcessorException("couldn't get resource definition for ($name)")
70 open fun resolveInputKeyMappingVariables(inputKeyMapping: Map<String, String>): Map<String, JsonNode> {
71 val resolvedInputKeyMapping = HashMap<String, JsonNode>()
72 if (MapUtils.isNotEmpty(inputKeyMapping)) {
73 for ((key, value) in inputKeyMapping) {
74 val resultValue = raRuntimeService.getResolutionStore(value)
75 resolvedInputKeyMapping[key] = resultValue
78 return resolvedInputKeyMapping
81 open suspend fun resolveFromInputKeyMapping(valueToResolve: String, keyMapping: MutableMap<String, JsonNode>):
83 if (valueToResolve.isEmpty() || !valueToResolve.contains("$")) {
86 //TODO("Optimize to JSON Node directly without velocity").asJsonNode().toString()
87 return BluePrintVelocityTemplateService.generateContent(valueToResolve, keyMapping.asJsonNode().toString())
90 final override suspend fun applyNB(resourceAssignment: ResourceAssignment): Boolean {
92 processNB(resourceAssignment)
93 } catch (runtimeException: RuntimeException) {
94 log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
95 recoverNB(runtimeException, resourceAssignment)
101 suspend fun executeScript(resourceAssignment: ResourceAssignment) {
102 return when (scriptType) {
103 BluePrintConstants.SCRIPT_JYTHON -> {
104 executeScriptBlocking(resourceAssignment)
107 executeScriptNB(resourceAssignment)
112 private suspend fun executeScriptNB(resourceAssignment: ResourceAssignment) {
114 processNB(resourceAssignment)
115 } catch (runtimeException: RuntimeException) {
116 log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
117 recoverNB(runtimeException, resourceAssignment)
121 private fun executeScriptBlocking(resourceAssignment: ResourceAssignment) {
123 process(resourceAssignment)
124 } catch (runtimeException: RuntimeException) {
125 log.error("failed in ResourceAssignmentProcessor : ${runtimeException.message}", runtimeException)
126 recover(runtimeException, resourceAssignment)
131 * If Jython Script, Override Blocking methods(process() and recover())
132 * If Kotlin or Internal Scripts, Override non blocking methods ( processNB() and recoverNB()), so default
134 * methods will have default implementation,
136 * Always applyNB() method will be invoked, apply() won't be called from parent
139 final override fun apply(resourceAssignment: ResourceAssignment): Boolean {
140 throw BluePrintException("Not Implemented, use applyNB method")
143 final override fun prepareRequest(resourceAssignment: ResourceAssignment): ResourceAssignment {
144 throw BluePrintException("Not Implemented required")
147 final override fun prepareResponse(): Boolean {
148 throw BluePrintException("Not Implemented required")
151 final override suspend fun prepareRequestNB(resourceAssignment: ResourceAssignment): ResourceAssignment {
152 throw BluePrintException("Not Implemented required")
155 final override suspend fun prepareResponseNB(): Boolean {
156 throw BluePrintException("Not Implemented required")
159 override fun process(resourceAssignment: ResourceAssignment) {
160 throw BluePrintException("Not Implemented, child class will implement this")
163 override fun recover(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
164 throw BluePrintException("Not Implemented, child class will implement this")
167 fun addError(type: String, name: String, error: String) {
168 raRuntimeService.getBluePrintError().addError(type, name, error)
171 fun addError(error: String) {
172 raRuntimeService.getBluePrintError().addError(error)