io.github.kwahome.sopa.renderers.JSONRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sopa-api Show documentation
Configurable and extensible structured logging on top of `slf4j` API to generate easily parsable log messages in desired formats.
The newest version!
/*
 * MIT License
 *
 * Copyright (c) 2018 Kelvin Wahome
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package io.github.kwahome.sopa.renderers;

import java.io.StringWriter;

import javax.json.Json;
import javax.json.JsonObjectBuilder;
import javax.json.JsonWriter;

import org.slf4j.Logger;

import io.github.kwahome.sopa.StructLoggerConfig;
import io.github.kwahome.sopa.interfaces.LogRenderer;

/**
 * Basic JSON renderer.
 *
 * Formats using Glassfish JSON library as it has minimal dependencies.
 *
 * @author Kelvin Wahome
 */
public class JSONRenderer implements LogRenderer {
    private static final JSONRenderer INSTANCE = new JSONRenderer();

    /**
     * Returns a new {@link JSONRenderer} instance if it does not exist or the existing instance
     * ig it does
     *
     * @return {@link JSONRenderer}
     */
    public static JSONRenderer getInstance() {
        return INSTANCE;
    }

    @Override
    public final JsonObjectBuilder start(Logger logger) {
        return Json.createObjectBuilder();
    }

    @Override
    public final LogRenderer addMessage(
            Logger logger, JsonObjectBuilder jsonObjectBuilder, String message) {
        jsonObjectBuilder.add("message", message);
        return this;
    }

    @Override
    public final LogRenderer addKeyValue(
            Logger logger, JsonObjectBuilder jsonObjectBuilder, String key, Object value) {
        if ("message".equals(key)) {
            key = "message1";
            logger.warn(String.format("%s key `message` renamed to `%s` to avoid overriding default log message field.",
                    StructLoggerConfig.getSopaLoggerTag(), key));
        }

        // different methods per type
        if (value == null) {
            jsonObjectBuilder.addNull(key);
        } else if (value instanceof Boolean) {
            jsonObjectBuilder.add(key, (boolean) value);
        } else if (value instanceof Integer || value instanceof Short) {
            jsonObjectBuilder.add(key, (int) value);
        } else if (value instanceof Long) {
            jsonObjectBuilder.add(key, (long) value);
        } else if (value instanceof Double || value instanceof Float) {
            jsonObjectBuilder.add(key, (double) value);
        } else {
            jsonObjectBuilder.add(key, String.valueOf(value));
        }
        return this;
    }

    @Override
    public final String end(Logger logger, JsonObjectBuilder jsonObjectBuilder) {
        StringWriter stringWriter = new StringWriter();
        try (JsonWriter jsonWriter = Json.createWriter(stringWriter)) {
            jsonWriter.writeObject(jsonObjectBuilder.build());
        }
        return stringWriter.toString();
    }
}