ms/blueprintsprocessor/modules/blueprints/blueprint-validation/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/validation/BluePrintAttributeDefinitionValidatorImpl.kt

   1 /*
   2  * Copyright © 2017-2018 AT&T Intellectual Property.
   3  * Modifications Copyright © 2018 IBM.
   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.controllerblueprints.validation
  19
  20 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintException
  21 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintTypes
  22 import org.onap.ccsdk.cds.controllerblueprints.core.data.AttributeDefinition
  23 import org.onap.ccsdk.cds.controllerblueprints.core.format
  24 import org.onap.ccsdk.cds.controllerblueprints.core.interfaces.BluePrintAttributeDefinitionValidator
  25 import org.onap.ccsdk.cds.controllerblueprints.core.interfaces.BluePrintTypeValidatorService
  26 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintRuntimeService
  27 import org.slf4j.LoggerFactory
  28 import org.springframework.beans.factory.config.ConfigurableBeanFactory
  29 import org.springframework.context.annotation.Scope
  30 import org.springframework.stereotype.Service
  31
  32 @Service("default-attribute-definition-validator")
  33 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
  34 open class BluePrintAttributeDefinitionValidatorImpl(private val bluePrintTypeValidatorService: BluePrintTypeValidatorService) :
  35     BluePrintAttributeDefinitionValidator {
  36
  37     private val log = LoggerFactory.getLogger(BluePrintServiceTemplateValidatorImpl::class.toString())
  38
  39     lateinit var bluePrintRuntimeService: BluePrintRuntimeService<*>
  40
  41     override fun validate(
  42         bluePrintRuntimeService: BluePrintRuntimeService<*>,
  43         name: String,
  44         attributeDefinition: AttributeDefinition
  45     ) {
  46
  47         log.trace("Validating AttributeDefinition($name)")
  48         this.bluePrintRuntimeService = bluePrintRuntimeService
  49         val dataType: String = attributeDefinition.type
  50
  51         when {
  52             BluePrintTypes.validPrimitiveTypes().contains(dataType) -> {
  53                 // Do Nothing
  54             }
  55             BluePrintTypes.validComplexTypes().contains(dataType) -> {
  56                 // Do Nothing
  57             }
  58             BluePrintTypes.validCollectionTypes().contains(dataType) -> {
  59                 val entrySchemaType: String = attributeDefinition.entrySchema?.type
  60                     ?: throw BluePrintException("Entry schema for DataType ($dataType) for the property ($name) not found")
  61                 checkPrimitiveOrComplex(entrySchemaType, name)
  62             }
  63             else -> checkPropertyDataType(dataType, name)
  64         }
  65     }
  66
  67     private fun checkPrimitiveOrComplex(dataType: String, propertyName: String): Boolean {
  68         if (BluePrintTypes.validPrimitiveTypes().contains(dataType) || checkDataType(dataType)) {
  69             return true
  70         } else {
  71             throw BluePrintException("DataType($dataType) for the attribute($propertyName) is not valid")
  72         }
  73     }
  74
  75     private fun checkPropertyDataType(dataTypeName: String, propertyName: String) {
  76
  77         val dataType = bluePrintRuntimeService.bluePrintContext().serviceTemplate.dataTypes?.get(dataTypeName)
  78             ?: throw BluePrintException(format("DataType ({}) for the property ({}) not found", dataTypeName, propertyName))
  79
  80         checkValidDataTypeDerivedFrom(propertyName, dataType.derivedFrom)
  81     }
  82
  83     private fun checkDataType(key: String): Boolean {
  84         return bluePrintRuntimeService.bluePrintContext().serviceTemplate.dataTypes?.containsKey(key) ?: false
  85     }
  86
  87     open fun checkValidDataTypeDerivedFrom(dataTypeName: String, derivedFrom: String) {
  88         check(BluePrintTypes.validDataTypeDerivedFroms.contains(derivedFrom)) {
  89             throw BluePrintException("Failed to get DataType($dataTypeName)'s  derivedFrom($derivedFrom) definition ")
  90         }
  91     }
  92 }