io.sphere.sdk.utils.JsonUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common Show documentation
common
There is a newer version: 1.0.0-M3
package io.sphere.sdk.utils;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectWriter;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
import com.google.common.base.Charsets;
import com.google.common.io.Resources;
import org.zapodot.jackson.java8.JavaOptionalModule;

import java.io.IOException;
import java.net.URL;
import java.util.Iterator;
import java.util.Map;

final public class JsonUtils {
    private static ObjectMapper objectMapper = newObjectMapper();

    private JsonUtils() {
    }

    public static ObjectMapper newObjectMapper() {
        return new ObjectMapper().
                registerModule(new JavaOptionalModule()).
                registerModule(new ParameterNamesModule()).
                registerModule(new Iso8601DateTimeJacksonModule()).
                configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    }

    public static String toJson(final Object object) {
        try {
            return objectMapper.writeValueAsString(object);
        } catch (final JsonProcessingException e) {
            //to extend RuntimeException to be able to catch specific classes
            throw new RuntimeException(e);
        }
    }

    /** Pretty prints given JSON string, replacing passwords by {@code 'xxxxx'}.
     * @param json JSON code as String which should be formatted
     * @return json formatted
     */
    public static String prettyPrintJsonStringSecure(String json) {
        try {
            ObjectMapper jsonParser = new ObjectMapper();
            JsonNode jsonTree = jsonParser.readValue(json, JsonNode.class);
            secure(jsonTree);
            ObjectWriter writer = jsonParser.writerWithDefaultPrettyPrinter();
            return writer.writeValueAsString(jsonTree);
        } catch (IOException e) {
           throw new RuntimeException(e);
        }
    }

    /**
     * Works like {@link JsonUtils#prettyPrintJsonStringSecure(java.lang.String)} but returns the unparsed JSON string if the
     * formatting fails.
     * @param json
     * @return
     */
    //TODO rename
    public static String prettyPrintJsonStringSecureWithFallback(String json) {
        String result = json;
        try {
            ObjectMapper jsonParser = new ObjectMapper();
            JsonNode jsonTree = jsonParser.readValue(json, JsonNode.class);
            secure(jsonTree);
            ObjectWriter writer = jsonParser.writerWithDefaultPrettyPrinter();
            result = writer.writeValueAsString(jsonTree);
        } catch (IOException e) {
            result = json;
        }
        return result;
    }

    public static  T readObjectFromJsonFileInClasspath(final String resourcePath, final TypeReference typeReference) {
        final URL url = Resources.getResource(resourcePath);
        try {
            String jsonAsString = Resources.toString(url, Charsets.UTF_8);
            return readObjectFromJsonString(typeReference, jsonAsString);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    public static  T readObjectFromJsonString(TypeReference typeReference, String jsonAsString) {
        try {
            return objectMapper.readValue(jsonAsString, typeReference);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }


    /** Very simple way to "erase" passwords -
     *  replaces all field values whose names contains {@code 'pass'} by {@code 'xxxxx'}. */
    private static JsonNode secure(JsonNode node) {
        if (node.isObject()) {
            ObjectNode objectNode = (ObjectNode)node;
            Iterator> fields = node.fields();
            while (fields.hasNext()) {
                Map.Entry field = fields.next();
                if (field.getValue().isTextual() && field.getKey().toLowerCase().contains("pass")) {
                    objectNode.put(field.getKey(), "xxxxx");
                } else {
                    secure(field.getValue());
                }
            }
            return objectNode;
        } else if (node.isArray()) {
            ArrayNode arrayNode = (ArrayNode)node;
            Iterator elements = arrayNode.elements();
            while (elements.hasNext()) {
                secure(elements.next());
            }
            return arrayNode;
        } else {
            return node;
        }
    }
}