ms/controllerblueprints/modules/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/utils/JacksonUtils.kt

   1 /*\r
   2  * Copyright © 2017-2018 AT&T Intellectual Property.\r
   3  * Modifications Copyright © 2018 IBM.\r
   4  *\r
   5  * Licensed under the Apache License, Version 2.0 (the "License");\r
   6  * you may not use this file except in compliance with the License.\r
   7  * You may obtain a copy of the License at\r
   8  *\r
   9  *     http://www.apache.org/licenses/LICENSE-2.0\r
  10  *\r
  11  * Unless required by applicable law or agreed to in writing, software\r
  12  * distributed under the License is distributed on an "AS IS" BASIS,\r
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  14  * See the License for the specific language governing permissions and\r
  15  * limitations under the License.\r
  16  */\r
  17 \r
  18 package org.onap.ccsdk.apps.controllerblueprints.core.utils\r
  19 \r
  20 import com.fasterxml.jackson.annotation.JsonInclude\r
  21 import com.fasterxml.jackson.core.type.TypeReference\r
  22 import com.fasterxml.jackson.databind.JsonNode\r
  23 import com.fasterxml.jackson.databind.SerializationFeature\r
  24 import com.fasterxml.jackson.databind.node.ArrayNode\r
  25 import com.fasterxml.jackson.databind.node.NullNode\r
  26 import com.fasterxml.jackson.databind.node.ObjectNode\r
  27 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\r
  28 import org.apache.commons.io.FileUtils\r
  29 import org.apache.commons.io.IOUtils\r
  30 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintException\r
  31 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintTypes\r
  32 import org.onap.ccsdk.apps.controllerblueprints.core.format\r
  33 import org.slf4j.LoggerFactory\r
  34 import java.io.File\r
  35 import java.nio.charset.Charset\r
  36 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintConstants\r
  37 \r
  38 /**\r
  39  *\r
  40  *\r
  41  * @author Brinda Santh\r
  42  */\r
  43 object JacksonUtils {\r
  44     private val log = LoggerFactory.getLogger(JacksonUtils::class.java)\r
  45 \r
  46     inline fun <reified T : Any> readValue(content: String): T =\r
  47             jacksonObjectMapper().readValue(content, T::class.java)\r
  48 \r
  49     @JvmStatic\r
  50     fun <T> readValue(content: String, valueType: Class<T>): T? {\r
  51         return jacksonObjectMapper().readValue(content, valueType)\r
  52     }\r
  53 \r
  54     @JvmStatic\r
  55     fun <T> readValueFromFile(fileName: String, valueType: Class<T>): T? {\r
  56         val content: String = FileUtils.readFileToString(File(fileName), Charset.defaultCharset())\r
  57                 ?: throw BluePrintException(format("Failed to read json file : {}", fileName))\r
  58         return readValue(content, valueType)\r
  59     }\r
  60 \r
  61     @JvmStatic\r
  62     fun jsonNodeFromObject(from: kotlin.Any): JsonNode = jacksonObjectMapper().convertValue(from, JsonNode::class.java)\r
  63 \r
  64     @JvmStatic\r
  65     fun jsonNodeFromClassPathFile(fileName: String): JsonNode {\r
  66         val content: String = IOUtils.toString(JacksonUtils::class.java.classLoader.getResourceAsStream(fileName), Charset.defaultCharset())\r
  67                 ?: throw BluePrintException(String.format("Failed to read json file : %s", fileName))\r
  68         return jsonNode(content)\r
  69     }\r
  70 \r
  71     @JvmStatic\r
  72     fun jsonNodeFromFile(fileName: String): JsonNode {\r
  73         val content: String = FileUtils.readFileToString(File(fileName), Charset.defaultCharset())\r
  74                 ?: throw BluePrintException(format("Failed to read json file : {}", fileName))\r
  75         return jsonNode(content)\r
  76     }\r
  77 \r
  78     @JvmStatic\r
  79     fun jsonNode(content: String): JsonNode {\r
  80         return jacksonObjectMapper().readTree(content)\r
  81     }\r
  82 \r
  83     @JvmStatic\r
  84     fun getJson(any: kotlin.Any): String {\r
  85         return getJson(any, false)\r
  86     }\r
  87 \r
  88     @JvmStatic\r
  89     fun getJson(any: kotlin.Any, pretty: Boolean = false): String {\r
  90         val objectMapper = jacksonObjectMapper()\r
  91         objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL)\r
  92         if (pretty) {\r
  93             objectMapper.enable(SerializationFeature.INDENT_OUTPUT)\r
  94         }\r
  95         return objectMapper.writeValueAsString(any)\r
  96     }\r
  97 \r
  98     @JvmStatic\r
  99     fun <T> getListFromJson(content: String, valueType: Class<T>): List<T>? {\r
 100         val objectMapper = jacksonObjectMapper()\r
 101         val javaType = objectMapper.typeFactory.constructCollectionType(List::class.java, valueType)\r
 102         return objectMapper.readValue<List<T>>(content, javaType)\r
 103     }\r
 104 \r
 105     @JvmStatic\r
 106     fun <T> getMapFromJson(content: String, valueType: Class<T>): MutableMap<String, T>? {\r
 107         val objectMapper = jacksonObjectMapper()\r
 108         val typeRef = object : TypeReference<MutableMap<String, T>>() {}\r
 109         return objectMapper.readValue(content, typeRef)\r
 110     }\r
 111 \r
 112     @JvmStatic\r
 113     fun checkJsonNodeValueOfType(type: String, jsonNode: JsonNode) : Boolean {\r
 114         if (BluePrintTypes.validPrimitiveTypes().contains(type)) {\r
 115             return checkJsonNodeValueOfPrimitiveType(type, jsonNode)\r
 116         } else if (BluePrintTypes.validCollectionTypes().contains(type)) {\r
 117             return checkJsonNodeValueOfCollectionType(type, jsonNode)\r
 118         }\r
 119         return false;\r
 120     }\r
 121 \r
 122     @JvmStatic\r
 123     fun checkJsonNodeValueOfPrimitiveType(primitiveType: String, jsonNode: JsonNode): Boolean {\r
 124         when (primitiveType) {\r
 125             BluePrintConstants.DATA_TYPE_STRING -> {\r
 126                 return jsonNode.isTextual\r
 127             }\r
 128             BluePrintConstants.DATA_TYPE_BOOLEAN -> {\r
 129                 return jsonNode.isBoolean\r
 130             }\r
 131             BluePrintConstants.DATA_TYPE_INTEGER -> {\r
 132                 return jsonNode.isInt\r
 133             }\r
 134             BluePrintConstants.DATA_TYPE_FLOAT -> {\r
 135                 return jsonNode.isDouble\r
 136             }\r
 137             BluePrintConstants.DATA_TYPE_TIMESTAMP -> {\r
 138                 return jsonNode.isTextual\r
 139             }\r
 140             else ->\r
 141                 return false\r
 142         }\r
 143     }\r
 144 \r
 145     @JvmStatic\r
 146     fun checkJsonNodeValueOfCollectionType(type: String, jsonNode: JsonNode): Boolean {\r
 147         when (type) {\r
 148             BluePrintConstants.DATA_TYPE_LIST ->\r
 149                 return jsonNode.isArray\r
 150             BluePrintConstants.DATA_TYPE_MAP ->\r
 151                 return jsonNode.isContainerNode\r
 152             else ->\r
 153                 return false\r
 154         }\r
 155 \r
 156     }\r
 157 \r
 158     @JvmStatic\r
 159     fun populatePrimitiveValues(key: String, value: Any, primitiveType: String, objectNode: ObjectNode) {\r
 160         if (BluePrintConstants.DATA_TYPE_BOOLEAN == primitiveType) {\r
 161             objectNode.put(key, value as Boolean)\r
 162         } else if (BluePrintConstants.DATA_TYPE_INTEGER == primitiveType) {\r
 163             objectNode.put(key, value as Int)\r
 164         } else if (BluePrintConstants.DATA_TYPE_FLOAT == primitiveType) {\r
 165             objectNode.put(key, value as Float)\r
 166         } else if (BluePrintConstants.DATA_TYPE_TIMESTAMP == primitiveType) {\r
 167             objectNode.put(key, value as String)\r
 168         } else {\r
 169             objectNode.put(key, value as String)\r
 170         }\r
 171     }\r
 172 \r
 173     @JvmStatic\r
 174     fun populatePrimitiveValues(value: Any, primitiveType: String, objectNode: ArrayNode) {\r
 175         if (BluePrintConstants.DATA_TYPE_BOOLEAN == primitiveType) {\r
 176             objectNode.add(value as Boolean)\r
 177         } else if (BluePrintConstants.DATA_TYPE_INTEGER == primitiveType) {\r
 178             objectNode.add(value as Int)\r
 179         } else if (BluePrintConstants.DATA_TYPE_FLOAT == primitiveType) {\r
 180             objectNode.add(value as Float)\r
 181         } else if (BluePrintConstants.DATA_TYPE_TIMESTAMP == primitiveType) {\r
 182             objectNode.add(value as String)\r
 183         } else {\r
 184             objectNode.add(value as String)\r
 185         }\r
 186     }\r
 187 \r
 188     @JvmStatic\r
 189     fun populatePrimitiveDefaultValues(key: String, primitiveType: String, objectNode: ObjectNode) {\r
 190         if (BluePrintConstants.DATA_TYPE_BOOLEAN == primitiveType) {\r
 191             objectNode.put(key, false)\r
 192         } else if (BluePrintConstants.DATA_TYPE_INTEGER == primitiveType) {\r
 193             objectNode.put(key, 0)\r
 194         } else if (BluePrintConstants.DATA_TYPE_FLOAT == primitiveType) {\r
 195             objectNode.put(key, 0.0)\r
 196         } else {\r
 197             objectNode.put(key, "")\r
 198         }\r
 199     }\r
 200 \r
 201     @JvmStatic\r
 202     fun populatePrimitiveDefaultValuesForArrayNode(primitiveType: String, arrayNode: ArrayNode) {\r
 203         if (BluePrintConstants.DATA_TYPE_BOOLEAN == primitiveType) {\r
 204             arrayNode.add(false)\r
 205         } else if (BluePrintConstants.DATA_TYPE_INTEGER == primitiveType) {\r
 206             arrayNode.add(0)\r
 207         } else if (BluePrintConstants.DATA_TYPE_FLOAT == primitiveType) {\r
 208             arrayNode.add(0.0)\r
 209         } else {\r
 210             arrayNode.add("")\r
 211         }\r
 212     }\r
 213 \r
 214     @JvmStatic\r
 215     fun populateJsonNodeValues(key: String, nodeValue: JsonNode?, type: String, objectNode: ObjectNode) {\r
 216         if (nodeValue == null || nodeValue is NullNode) {\r
 217             objectNode.set(key, nodeValue)\r
 218         } else if (BluePrintTypes.validPrimitiveTypes().contains(type)) {\r
 219             if (BluePrintConstants.DATA_TYPE_BOOLEAN == type) {\r
 220                 objectNode.put(key, nodeValue.asBoolean())\r
 221             } else if (BluePrintConstants.DATA_TYPE_INTEGER == type) {\r
 222                 objectNode.put(key, nodeValue.asInt())\r
 223             } else if (BluePrintConstants.DATA_TYPE_FLOAT == type) {\r
 224                 objectNode.put(key, nodeValue.floatValue())\r
 225             } else if (BluePrintConstants.DATA_TYPE_TIMESTAMP == type) {\r
 226                 objectNode.put(key, nodeValue.asText())\r
 227             } else {\r
 228                 objectNode.put(key, nodeValue.asText())\r
 229             }\r
 230         } else {\r
 231             objectNode.set(key, nodeValue)\r
 232         }\r
 233     }\r
 234 }