ms/blueprintsprocessor/functions/resource-resolution/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/resource/resolution/processor/DatabaseResourceAssignmentProcessor.kt

   1 /*
   2  *  Copyright © 2018 IBM.
   3  *  Modifications Copyright © 2017-2018 AT&T Intellectual Property.
   4  *
   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
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor
  19
  20 import com.fasterxml.jackson.databind.node.JsonNodeFactory
  21 import com.fasterxml.jackson.databind.node.MissingNode
  22 import com.fasterxml.jackson.databind.node.NullNode
  23 import org.onap.ccsdk.cds.blueprintsprocessor.db.BluePrintDBLibGenericService
  24 import org.onap.ccsdk.cds.blueprintsprocessor.db.primary.BluePrintDBLibPropertySevice
  25 import org.onap.ccsdk.cds.blueprintsprocessor.db.primary.PrimaryDBLibGenericService
  26 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.DatabaseResourceSource
  27 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR
  28 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
  29 import org.onap.ccsdk.cds.controllerblueprints.core.*
  30 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  31 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
  32 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceDictionaryConstants
  33 import org.slf4j.LoggerFactory
  34 import org.springframework.beans.factory.config.ConfigurableBeanFactory
  35 import org.springframework.context.annotation.Scope
  36 import org.springframework.stereotype.Service
  37 import java.util.*
  38
  39 /**
  40  * DatabaseResourceAssignmentProcessor
  41  *
  42  * @author Kapil Singal
  43  */
  44 @Service("${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-processor-db")
  45 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
  46 open class DatabaseResourceAssignmentProcessor(private val bluePrintDBLibPropertySevice: BluePrintDBLibPropertySevice, private val primaryDBLibGenericService: PrimaryDBLibGenericService)
  47     : ResourceAssignmentProcessor() {
  48
  49     private val logger = LoggerFactory.getLogger(DatabaseResourceAssignmentProcessor::class.java)
  50
  51     override fun getName(): String {
  52         return "${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-processor-db"
  53     }
  54
  55     override fun process(resourceAssignment: ResourceAssignment) {
  56         try {
  57             validate(resourceAssignment)
  58
  59             // Check if It has Input
  60             try {
  61                 val value = raRuntimeService.getInputValue(resourceAssignment.name)
  62                 if (value !is NullNode && value !is MissingNode) {
  63                     logger.info("processor-db source template key (${resourceAssignment.name}) found from input and value is ($value)")
  64                     ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, value)
  65                 } else {
  66                     setValueFromDB(resourceAssignment)
  67                 }
  68             } catch (e: BluePrintProcessorException) {
  69                 setValueFromDB(resourceAssignment)
  70             }
  71
  72             // Check the value has populated for mandatory case
  73             ResourceAssignmentUtils.assertTemplateKeyValueNotNull(resourceAssignment)
  74         } catch (e: Exception) {
  75             ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, e.message)
  76             throw BluePrintProcessorException("Failed in template key ($resourceAssignment) assignments with: ${e.message}", e)
  77         }
  78     }
  79
  80     private fun setValueFromDB(resourceAssignment: ResourceAssignment) {
  81         val dName = resourceAssignment.dictionaryName
  82         val dSource = resourceAssignment.dictionarySource
  83         val resourceDefinition = resourceDictionaries[dName]
  84                 ?: throw BluePrintProcessorException("couldn't get resource dictionary definition for $dName")
  85         val resourceSource = resourceDefinition.sources[dSource]
  86                 ?: throw BluePrintProcessorException("couldn't get resource definition $dName source($dSource)")
  87         val resourceSourceProperties = checkNotNull(resourceSource.properties) { "failed to get source properties for $dName " }
  88         val sourceProperties = JacksonUtils.getInstanceFromMap(resourceSourceProperties, DatabaseResourceSource::class.java)
  89
  90         val sql = checkNotNull(sourceProperties.query) { "failed to get request query for $dName under $dSource properties" }
  91         val inputKeyMapping = checkNotNull(sourceProperties.inputKeyMapping) { "failed to get input-key-mappings for $dName under $dSource properties" }
  92
  93         logger.info("$dSource dictionary information : ($sql), ($inputKeyMapping), (${sourceProperties.outputKeyMapping})")
  94         val jdbcTemplate = blueprintDBLibService(sourceProperties)
  95
  96         val rows = jdbcTemplate.query(sql, populateNamedParameter(inputKeyMapping))
  97         if (rows.isNullOrEmpty()) {
  98             logger.warn("Failed to get $dSource result for dictionary name ($dName) the query ($sql)")
  99         } else {
 100             populateResource(resourceAssignment, sourceProperties, rows)
 101         }
 102     }
 103
 104     private fun blueprintDBLibService(sourceProperties: DatabaseResourceSource): BluePrintDBLibGenericService {
 105         return if (checkNotEmpty(sourceProperties.endpointSelector)) {
 106             val dbPropertiesJson = raRuntimeService.resolveDSLExpression(sourceProperties.endpointSelector!!)
 107             bluePrintDBLibPropertySevice.JdbcTemplate(dbPropertiesJson)
 108         } else {
 109             primaryDBLibGenericService
 110         }
 111
 112     }
 113
 114     @Throws(BluePrintProcessorException::class)
 115     private fun validate(resourceAssignment: ResourceAssignment) {
 116         checkNotEmptyOrThrow(resourceAssignment.name, "resource assignment template key is not defined")
 117         checkNotEmptyOrThrow(resourceAssignment.dictionaryName, "resource assignment dictionary name is not defined for template key (${resourceAssignment.name})")
 118         checkEqualsOrThrow(ResourceDictionaryConstants.SOURCE_PROCESSOR_DB, resourceAssignment.dictionarySource) {
 119             "resource assignment source is not ${ResourceDictionaryConstants.SOURCE_PROCESSOR_DB} but it is ${resourceAssignment.dictionarySource}"
 120         }
 121     }
 122
 123     private fun populateNamedParameter(inputKeyMapping: Map<String, String>): Map<String, Any> {
 124         val namedParameters = HashMap<String, Any>()
 125         inputKeyMapping.forEach {
 126             val expressionValue = raRuntimeService.getDictionaryStore(it.value).textValue()
 127             logger.trace("Reference dictionary key (${it.key}) resulted in value ($expressionValue)")
 128             namedParameters[it.key] = expressionValue
 129         }
 130         logger.info("Parameter information : ({})", namedParameters)
 131         return namedParameters
 132     }
 133
 134     @Throws(BluePrintProcessorException::class)
 135     private fun populateResource(resourceAssignment: ResourceAssignment, sourceProperties: DatabaseResourceSource, rows: List<Map<String, Any>>) {
 136         val dName = resourceAssignment.dictionaryName
 137         val dSource = resourceAssignment.dictionarySource
 138         val type = nullToEmpty(resourceAssignment.property?.type)
 139
 140         val outputKeyMapping = checkNotNull(sourceProperties.outputKeyMapping) { "failed to get output-key-mappings for $dName under $dSource properties" }
 141         logger.info("Response processing type($type)")
 142
 143         // Primitive Types
 144         when (type) {
 145             in BluePrintTypes.validPrimitiveTypes() -> {
 146                 val dbColumnValue = rows[0][outputKeyMapping[dName]]
 147                 logger.info("For template key (${resourceAssignment.name}) setting value as ($dbColumnValue)")
 148                 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, dbColumnValue)
 149             }
 150             in BluePrintTypes.validCollectionTypes() -> {
 151                 val entrySchemaType = returnNotEmptyOrThrow(resourceAssignment.property?.entrySchema?.type) { "Entry schema is not defined for dictionary ($dName) info" }
 152                 val arrayNode = JsonNodeFactory.instance.arrayNode()
 153                 rows.forEach {
 154                     if (entrySchemaType in BluePrintTypes.validPrimitiveTypes()) {
 155                         val dbColumnValue = it[outputKeyMapping[dName]]
 156                         // Add Array JSON
 157                         JacksonUtils.populatePrimitiveValues(dbColumnValue!!, entrySchemaType, arrayNode)
 158                     } else {
 159                         val arrayChildNode = JsonNodeFactory.instance.objectNode()
 160                         for (mapping in outputKeyMapping.entries) {
 161                             val dbColumnValue = checkNotNull(it[mapping.key])
 162                             val propertyTypeForDataType = ResourceAssignmentUtils.getPropertyType(raRuntimeService, entrySchemaType, mapping.key)
 163                             JacksonUtils.populatePrimitiveValues(mapping.key, dbColumnValue, propertyTypeForDataType, arrayChildNode)
 164                         }
 165                         arrayNode.add(arrayChildNode)
 166                     }
 167                 }
 168                 logger.info("For template key (${resourceAssignment.name}) setting value as ($arrayNode)")
 169                 // Set the List of Complex Values
 170                 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, arrayNode)
 171             }
 172             else -> {
 173                 // Complex Types
 174                 val row = rows[0]
 175                 val objectNode = JsonNodeFactory.instance.objectNode()
 176                 for (mapping in outputKeyMapping.entries) {
 177                     val dbColumnValue = checkNotNull(row[mapping.key])
 178                     val propertyTypeForDataType = ResourceAssignmentUtils.getPropertyType(raRuntimeService, type, mapping.key)
 179                     JacksonUtils.populatePrimitiveValues(mapping.key, dbColumnValue, propertyTypeForDataType, objectNode)
 180                 }
 181                 logger.info("For template key (${resourceAssignment.name}) setting value as ($objectNode)")
 182                 ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, objectNode)
 183             }
 184         }
 185     }
 186
 187     override fun recover(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
 188         raRuntimeService.getBluePrintError().addError(runtimeException.message!!)
 189     }
 190 }