src/main/java/org/onap/nbi/commons/JacksonFilter.java

   1 /**
   2  *     Copyright (c) 2018 Orange
   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.nbi.commons;
  17
  18 import java.math.BigDecimal;
  19 import java.util.ArrayList;
  20 import java.util.Arrays;
  21 import java.util.Collection;
  22 import java.util.LinkedHashSet;
  23 import java.util.LinkedList;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Set;
  27 import org.springframework.util.LinkedMultiValueMap;
  28 import org.springframework.util.MultiValueMap;
  29 import com.fasterxml.jackson.databind.JsonNode;
  30 import com.fasterxml.jackson.databind.ObjectMapper;
  31 import com.fasterxml.jackson.databind.node.ArrayNode;
  32 import com.fasterxml.jackson.databind.node.ObjectNode;
  33
  34 public class JacksonFilter {
  35
  36     private static final List<String> SKIPPED_FIELDS = Arrays.asList("internalId");
  37
  38     private JacksonFilter() {
  39     }
  40
  41     public static <R> List<ObjectNode> createNodes(List<R> list, JsonRepresentation jsonRepresentation) {
  42
  43         Set<R> set;
  44         if (list == null) {
  45             set = new LinkedHashSet<>();
  46         } else {
  47             set = new LinkedHashSet<>(list);
  48         }
  49         return createNodes(set, jsonRepresentation);
  50     }
  51
  52     public static <R> List<ObjectNode> createNodes(Collection<R> collection, JsonRepresentation jsonRepresentation) {
  53         List<ObjectNode> nodeList = new ArrayList<>();
  54         for (R element : collection) {
  55             ObjectNode node = createNode(element, jsonRepresentation);
  56             nodeList.add(node);
  57         }
  58         return nodeList;
  59     }
  60
  61     public static <R> ObjectNode createNode(R bean, JsonRepresentation jsonRepresentation) {
  62         ObjectMapper mapper = new ObjectMapper();
  63         return JacksonFilter.createNode(mapper, bean, jsonRepresentation.getAttributes());
  64     }
  65
  66     private static <R> ObjectNode createNode(ObjectMapper mapper, R bean, Set<String> names) {
  67         // split fieldNames in 2 categories :
  68         // simpleFields for simple property names with no '.'
  69         // nestedFields for nested property names with a '.'
  70         Set<String> simpleFields = new LinkedHashSet<>();
  71         MultiValueMap nestedFields = new LinkedMultiValueMap();
  72         buildFields(names, simpleFields, nestedFields);
  73
  74         // create a simple node with only one level containing all simples
  75         // properties
  76         ObjectNode rootNode = JacksonFilter.createNodeWithSimpleFields(mapper, bean, simpleFields);
  77
  78         // create nested nodes with deeper levels
  79         Set<Map.Entry<String, List<String>>> entrySet = nestedFields.entrySet();
  80         // for each nested value, create recursively a node
  81         for (Map.Entry<String, List<String>> entry : entrySet) {
  82             String rootFieldName = entry.getKey();
  83             // add in current node only if full value is not already present in
  84             // 1st level
  85             if (!simpleFields.contains(rootFieldName)) {
  86                 Object nestedBean = BeanUtils.getNestedProperty(bean, rootFieldName);
  87                 // add only non null fields
  88                 if (nestedBean == null) {
  89                     continue;
  90                 }
  91                 Set<String> nestedFieldNames = new LinkedHashSet<>(entry.getValue());
  92                 // current node is an array or a list
  93                 if ((nestedBean.getClass().isArray()) || (Collection.class.isAssignableFrom(nestedBean.getClass()))) {
  94                     handleListNode(mapper, rootNode, rootFieldName, nestedBean, nestedFieldNames);
  95                 } else {
  96                     // create recursively a node and add it in current root node
  97                     createNodeRecursively(mapper, rootNode, rootFieldName, nestedBean, nestedFieldNames);
  98                 }
  99             }
 100         }
 101         return rootNode;
 102     }
 103
 104     private static void createNodeRecursively(ObjectMapper mapper, ObjectNode rootNode, String rootFieldName,
 105             Object nestedBean, Set<String> nestedFieldNames) {
 106         ObjectNode nestedNode = JacksonFilter.createNode(mapper, nestedBean, nestedFieldNames);
 107         if ((nestedNode != null) && (nestedNode.size() > 0)) {
 108             rootNode.set(rootFieldName, nestedNode);
 109         }
 110     }
 111
 112     private static void buildFields(Set<String> names, Set<String> simpleFields, MultiValueMap nestedFields) {
 113         for (String name : names) {
 114             int index = name.indexOf('.');
 115             boolean isNestedField = (index > 0) && (index < name.length());
 116             if (isNestedField) {
 117                 String rootFieldName = name.substring(0, index);
 118                 String subFieldName = name.substring(index + 1);
 119                 nestedFields.add(rootFieldName, subFieldName);
 120             } else {
 121                 simpleFields.add(name);
 122             }
 123         }
 124     }
 125
 126     private static void handleListNode(ObjectMapper mapper, ObjectNode rootNode, String rootFieldName,
 127             Object nestedBean, Set<String> nestedFieldNames) {
 128         Object[] array = null;
 129         if ((nestedBean.getClass().isArray())) {
 130             array = (Object[]) nestedBean;
 131         } else {
 132             Collection<?> collection = (Collection<?>) nestedBean;
 133             array = collection.toArray();
 134         }
 135         if (array.length > 0) {
 136             // create a node for each element in array
 137             // and add created node in an arrayNode
 138             Collection<JsonNode> nodes = new LinkedList<>();
 139             for (Object object : array) {
 140                 ObjectNode nestedNode = JacksonFilter.createNode(mapper, object, nestedFieldNames);
 141                 if ((nestedNode != null) && (nestedNode.size() > 0)) {
 142                     nodes.add(nestedNode);
 143                 }
 144             }
 145             ArrayNode arrayNode = mapper.createArrayNode();
 146             arrayNode.addAll(nodes);
 147             if (arrayNode.size() > 0) {
 148                 rootNode.set(rootFieldName, arrayNode);
 149             }
 150         }
 151     }
 152
 153     private static <R> ObjectNode createNodeWithSimpleFields(ObjectMapper mapper, R bean, Set<String> names) {
 154         ObjectNode node = mapper.createObjectNode();
 155         for (String name : names) {
 156             // Prevent getting value of some fields
 157             if (SKIPPED_FIELDS.contains(name)) {
 158                 continue;
 159             }
 160
 161             JacksonFilter.nodePut(node, name, BeanUtils.getNestedProperty(bean, name));
 162         }
 163         return node;
 164     }
 165
 166     private static void nodePut(ObjectNode node, String name, Object value) {
 167         if (value instanceof Boolean) {
 168             node.put(name, (Boolean) value);
 169         } else if (value instanceof Integer) {
 170             node.put(name, (Integer) value);
 171         } else if (value instanceof Long) {
 172             node.put(name, (Long) value);
 173         } else if (value instanceof Float) {
 174             node.put(name, (Float) value);
 175         } else if (value instanceof Double) {
 176             node.put(name, (Double) value);
 177         } else if (value instanceof BigDecimal) {
 178             node.put(name, (BigDecimal) value);
 179         } else if (value instanceof String) {
 180             node.put(name, (String) value);
 181         } else {
 182             node.putPOJO(name, value);
 183         }
 184     }
 185
 186 }