ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/interfaces/BlueprintTemplateService.kt

   1 /*
   2  * Copyright © 2019 IBM, Bell Canada.
   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 package org.onap.ccsdk.cds.controllerblueprints.core.interfaces
  17
  18 import com.fasterxml.jackson.core.io.CharTypes
  19 import com.fasterxml.jackson.databind.node.JsonNodeFactory
  20 import com.fasterxml.jackson.databind.node.TextNode
  21 import org.onap.ccsdk.cds.controllerblueprints.core.service.BlueprintRuntimeService
  22
  23 interface BlueprintTemplateService {
  24
  25     /**
  26      * Generate dynamique content using Velocity Template or Jinja template
  27      *
  28      * @param bluePrintRuntimeService blueprint runtime
  29      * @param nodeTemplateName node template
  30      * @param artifactName Artifact Name
  31      * @param jsonData json string data content to mash
  32      * @param ignoreJsonNull Ignore Null value in the JSON content
  33      * @param additionalContext (Key, value) mutable map for additional variables
  34      * @return Content result
  35      *
  36      **/
  37     suspend fun generateContent(
  38         bluePrintRuntimeService: BlueprintRuntimeService<*>,
  39         nodeTemplateName: String,
  40         artifactName: String,
  41         jsonData: String = "",
  42         ignoreJsonNull: Boolean = false,
  43         additionalContext: MutableMap<String, Any> = mutableMapOf()
  44     ): String
  45 }
  46
  47 /**
  48  * Customise JsonNodeFactory and TextNode, Since it introduces quotes for string data.
  49  */
  50 open class BlueprintJsonNodeFactory : JsonNodeFactory() {
  51
  52     override fun textNode(text: String): TextNode {
  53         return BlueprintTextNode(text)
  54     }
  55 }
  56
  57 open class BlueprintTextNode(v: String) : TextNode(v) {
  58
  59     override fun toString(): String {
  60         var len = this._value.length
  61         len = len + 2 + (len shr 4)
  62         val sb = StringBuilder(len)
  63         CharTypes.appendQuoted(sb, this._value)
  64         return sb.toString()
  65     }
  66 }