gerrit.onap Code Review - ccsdk/cds.git/blob

   1 /*
   2  *  Copyright © 2019 IBM.
   3  *
   4  *  Licensed under the Apache License, Version 2.0 (the "License");
   5  *  you may not use this file except in compliance with the License.
   6  *  You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  */
  16
  17 package org.onap.ccsdk.cds.blueprintsprocessor.services.execution
  18
  19 import com.fasterxml.jackson.databind.JsonNode
  20 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput
  21 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceOutput
  22 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
  23 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintException
  24 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
  25 import org.slf4j.LoggerFactory
  26
  27 abstract class AbstractScriptComponentFunction : AbstractComponentFunction() {
  28     private val log = LoggerFactory.getLogger(AbstractScriptComponentFunction::class.java)!!
  29
  30     companion object {
  31         const val DYNAMIC_PROPERTIES = "dynamic-properties"
  32     }
  33
  34     lateinit var scriptType: String
  35
  36     /**
  37      * Store Dynamic Script Dependency Instances, Objects present inside won't be persisted or state maintained.
  38      */
  39     var functionDependencyInstances: MutableMap<String, Any> = hashMapOf()
  40
  41     /**
  42      * This will be called from the scripts to serve instance from runtime to scripts.
  43      */
  44     open fun <T> functionDependencyInstanceAsType(name: String): T {
  45         return functionDependencyInstances[name] as? T
  46                 ?: throw BluePrintProcessorException("couldn't get script property instance ($name)")
  47     }
  48
  49     fun checkDynamicProperties(key: String): Boolean {
  50         return operationInputs[DYNAMIC_PROPERTIES]?.has(key) ?: false
  51     }
  52
  53     fun getDynamicProperties(key: String): JsonNode {
  54         return operationInputs[DYNAMIC_PROPERTIES]!!.get(key)
  55     }
  56
  57     suspend fun executeScript(executionServiceInput: ExecutionServiceInput) {
  58         return when (scriptType) {
  59             BluePrintConstants.SCRIPT_JYTHON -> {
  60                 executeScriptBlocking(executionServiceInput)
  61             }
  62             else -> {
  63                 executeScriptNB(executionServiceInput)
  64             }
  65         }
  66     }
  67
  68     private suspend fun executeScriptNB(executionServiceInput: ExecutionServiceInput) {
  69         try {
  70             processNB(executionServiceInput)
  71         } catch (runtimeException: RuntimeException) {
  72             log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
  73             recoverNB(runtimeException, executionServiceInput)
  74         }
  75     }
  76
  77     private fun executeScriptBlocking(executionServiceInput: ExecutionServiceInput) {
  78         try {
  79             process(executionServiceInput)
  80         } catch (runtimeException: RuntimeException) {
  81             log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
  82             recover(runtimeException, executionServiceInput)
  83         }
  84     }
  85
  86     /**
  87      * If Jython Script, Override Blocking methods(process() and recover())
  88      * If Kotlin or Internal Scripts, Override non blocking methods ( processNB() and recoverNB()), so default
  89      * blocking
  90      * methods will have default implementation,
  91      *
  92      * Always applyNB() method will be invoked, apply() won't be called from parent
  93      */
  94
  95     final override fun apply(executionServiceInput: ExecutionServiceInput): ExecutionServiceOutput {
  96         throw BluePrintException("Not Implemented, use applyNB method")
  97     }
  98
  99     final override fun prepareRequest(executionRequest: ExecutionServiceInput): ExecutionServiceInput {
 100         throw BluePrintException("Not Implemented required")
 101     }
 102
 103     final override fun prepareResponse(): ExecutionServiceOutput {
 104         throw BluePrintException("Not Implemented required")
 105     }
 106
 107     final override suspend fun applyNB(executionServiceInput: ExecutionServiceInput): ExecutionServiceOutput {
 108         throw BluePrintException("Not Implemented required")
 109     }
 110
 111     final override suspend fun prepareRequestNB(executionRequest: ExecutionServiceInput): ExecutionServiceInput {
 112         throw BluePrintException("Not Implemented required")
 113     }
 114
 115     final override suspend fun prepareResponseNB(): ExecutionServiceOutput {
 116         throw BluePrintException("Not Implemented required")
 117     }
 118
 119     override fun process(executionRequest: ExecutionServiceInput) {
 120         throw BluePrintException("Not Implemented, child class will implement this")
 121     }
 122
 123     override fun recover(runtimeException: RuntimeException, executionRequest: ExecutionServiceInput) {
 124         throw BluePrintException("Not Implemented, child class will implement this")
 125     }
 126 }