2 * Copyright © 2017-2018 AT&T Intellectual Property.
3 * Modifications Copyright © 2019 IBM.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 package org.onap.ccsdk.cds.controllerblueprints.core
20 import com.fasterxml.jackson.databind.JsonNode
21 import com.fasterxml.jackson.databind.node.*
22 import org.apache.commons.lang3.ObjectUtils
23 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
24 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JsonParserUtils
25 import org.slf4j.LoggerFactory
26 import org.slf4j.helpers.MessageFormatter
27 import kotlin.reflect.KClass
32 * @author Brinda Santh
35 fun <T : Any> logger(clazz: T) = LoggerFactory.getLogger(clazz.javaClass)!!
37 fun <T : KClass<*>> logger(clazz: T) = LoggerFactory.getLogger(clazz.java)!!
40 fun <T : Any> T.bpClone(): T {
41 return ObjectUtils.clone(this)
44 fun String.isJson(): Boolean {
45 return ((this.trim().startsWith("{") && this.trim().endsWith("}"))
46 || (this.trim().startsWith("[") && this.trim().endsWith("]")))
49 fun Any.asJsonString(intend: Boolean? = false): String {
50 return JacksonUtils.getJson(this, intend!!)
53 fun String.asJsonPrimitive(): TextNode {
57 // If you know the string is json content, then use the function directly
58 fun String.jsonAsJsonType(): JsonNode {
59 return JacksonUtils.jsonNode(this.trim())
62 fun Boolean.asJsonPrimitive(): BooleanNode {
63 return BooleanNode.valueOf(this)
66 fun Int.asJsonPrimitive(): IntNode {
67 return IntNode.valueOf(this)
70 fun Double.asJsonPrimitive(): DoubleNode {
71 return DoubleNode.valueOf(this)
75 * Utility to convert Primitive object to Json Type Primitive.
77 fun <T : Any?> T.asJsonPrimitive(): JsonNode {
78 return if (this == null || this is MissingNode || this is NullNode) {
83 this.asJsonPrimitive()
85 this.asJsonPrimitive()
87 this.asJsonPrimitive()
89 this.asJsonPrimitive()
91 throw BluePrintException("$this type is not supported")
96 /** Based on Blueprint DataType Convert string value to JsonNode Type **/
97 fun String.asJsonType(bpDataType: String): JsonNode {
98 return when (bpDataType.toLowerCase()) {
99 BluePrintConstants.DATA_TYPE_STRING -> this.asJsonPrimitive()
100 BluePrintConstants.DATA_TYPE_BOOLEAN -> this.toBoolean().asJsonPrimitive()
101 BluePrintConstants.DATA_TYPE_INTEGER -> this.toInt().asJsonPrimitive()
102 BluePrintConstants.DATA_TYPE_FLOAT -> this.toFloat().asJsonPrimitive()
103 BluePrintConstants.DATA_TYPE_DOUBLE -> this.toDouble().asJsonPrimitive()
104 // For List, Map and Complex Types.
105 else -> this.jsonAsJsonType()
110 * Utility to convert Complex or Primitive object to Json Type.
112 fun <T : Any?> T.asJsonType(): JsonNode {
113 return if (this == null || this is MissingNode || this is NullNode) {
121 this.jsonAsJsonType()
126 BooleanNode.valueOf(this)
128 IntNode.valueOf(this.toInt())
130 DoubleNode.valueOf(this.toDouble())
132 JacksonUtils.jsonNodeFromObject(this)
137 fun Map<String, *>.asJsonNode(): JsonNode {
138 return JacksonUtils.jsonNodeFromObject(this)
141 fun Map<String, *>.asObjectNode(): ObjectNode {
142 return JacksonUtils.objectNodeFromObject(this)
145 fun format(message: String, vararg args: Any?): String {
146 if (args != null && args.isNotEmpty()) {
147 return MessageFormatter.arrayFormat(message, args).message
152 fun <T : Any> Map<String, *>.castOptionalValue(key: String, valueType: KClass<T>): T? {
153 return if (containsKey(key)) {
160 fun <T : Any> Map<String, *>.castValue(key: String, valueType: KClass<T>): T {
161 if (containsKey(key)) {
164 throw BluePrintException("couldn't find the key $key")
168 fun ArrayNode.asListOfString(): List<String> {
169 return JacksonUtils.getListFromJsonNode(this, String::class.java)
172 fun <T> JsonNode.asType(clazzType: Class<T>): T {
173 return JacksonUtils.readValue(this, clazzType)
174 ?: throw BluePrintException("couldn't convert JsonNode of type $clazzType")
177 fun JsonNode.asListOfString(): List<String> {
178 check(this is ArrayNode) { "JsonNode is not of type ArrayNode" }
179 return this.asListOfString()
182 fun JsonNode.returnNullIfMissing(): JsonNode? {
183 return if (this is NullNode || this is MissingNode) {
188 fun <T : JsonNode> T?.isNull(): Boolean {
189 return this == null || this is NullNode || this is MissingNode
192 fun <T : JsonNode> T?.isNotNull(): Boolean {
193 return !(this == null || this is NullNode || this is MissingNode)
197 * Convert Json to map of json node, the root fields will be map keys
199 fun JsonNode.rootFieldsToMap(): MutableMap<String, JsonNode> {
200 if (this is ObjectNode) {
201 val propertyMap: MutableMap<String, JsonNode> = linkedMapOf()
202 this.fields().forEach {
203 propertyMap[it.key] = it.value
207 throw BluePrintException("json node should be Object Node Type")
211 fun JsonNode.removeNullNode() {
212 val it = this.iterator()
213 while (it.hasNext()) {
214 val child = it.next()
218 child.removeNullNode()
224 fun MutableMap<String, JsonNode>.putJsonElement(key: String, value: Any) {
225 val convertedValue = value.asJsonType()
226 this[key] = convertedValue
229 fun Map<String, JsonNode>.getAsString(key: String): String {
230 return this[key]?.asText() ?: throw BluePrintException("couldn't find value for key($key)")
233 fun Map<String, JsonNode>.getAsBoolean(key: String): Boolean {
234 return this[key]?.asBoolean() ?: throw BluePrintException("couldn't find value for key($key)")
237 fun Map<String, JsonNode>.getAsInt(key: String): Int {
238 return this[key]?.asInt() ?: throw BluePrintException("couldn't find value for key($key)")
241 fun Map<String, JsonNode>.getAsDouble(key: String): Double {
242 return this[key]?.asDouble() ?: throw BluePrintException("couldn't find value for key($key)")
245 fun Map<String, JsonNode>.getOptionalAsString(key: String): String? {
246 return if (this.containsKey(key)) this[key]!!.asText() else null
249 fun Map<String, JsonNode>.getOptionalAsBoolean(key: String): Boolean? {
250 return if (this.containsKey(key)) this[key]!!.asBoolean() else null
253 fun Map<String, JsonNode>.getOptionalAsInt(key: String): Int? {
254 return if (this.containsKey(key)) this[key]!!.asInt() else null
257 fun Map<String, JsonNode>.getOptionalAsDouble(key: String): Double? {
258 return if (this.containsKey(key)) this[key]!!.asDouble() else null
263 inline fun checkEquals(value1: String?, value2: String?, lazyMessage: () -> Any): Boolean {
264 if (value1.equals(value2, ignoreCase = true)) {
267 throw BluePrintException(lazyMessage().toString())
271 inline fun checkNotEmpty(value: String?, lazyMessage: () -> Any): String {
272 if (value == null || value.isEmpty()) {
273 val message = lazyMessage()
274 throw IllegalStateException(message.toString())
280 inline fun checkNotBlank(value: String?, lazyMessage: () -> Any): String {
281 if (value == null || value.isBlank()) {
282 val message = lazyMessage()
283 throw IllegalStateException(message.toString())
289 fun isNotEmpty(value: String?): Boolean {
290 return value != null && value.isNotEmpty()
293 fun isNotBlank(value: String?): Boolean {
294 return value != null && value.isNotBlank()
297 fun <T : String> T?.emptyTONull(): String? {
298 return if (this == null || this.isEmpty()) null else this
301 fun nullToEmpty(value: String?): String {
302 return if (isNotEmpty(value)) value!! else ""
305 inline fun <reified T : JsonNode> T.isComplexType(): Boolean {
306 return this is ObjectNode || this is ArrayNode
309 // Json Parsing Extensions
310 fun JsonNode.jsonPathParse(expression: String): JsonNode {
311 check(this.isComplexType()) { "$this is not complex or array node to apply expression" }
312 return JsonParserUtils.parse(this, expression)
315 // Json Path Extensions
316 fun JsonNode.jsonPaths(expression: String): List<String> {
317 check(this.isComplexType()) { "$this is not complex or array node to apply expression" }
318 return JsonParserUtils.paths(this, expression)