All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.github.naviud.logtracker.utils.LogTrackerUtil Maven / Gradle / Ivy

Go to download

LogTracker is a logger module done for Play framework which prepends a unique UUID(tracker id) for the log messages that are generated for a particular request. Tracker id can be passed from a HTTP header or will be selected randomly when a request is initiated.

There is a newer version: 1.1.3
Show newest version
/*
The MIT License (MIT)

Copyright (c) 2018 Udayanga Silva

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.naviud.logtracker.utils;

import io.github.naviud.logtracker.error.LogTrackerException;
import play.mvc.Http;

/**
 * Util class to hold Log tracker related util methods
 *
 */
public class LogTrackerUtil {

    private static ThreadLocal context = new ThreadLocal<>();

    /**
     * Method to fetch the log tracker id
     *
     * @return Log tracker id
     * @throws LogTrackerException if error occurs when getting the tracker id
     */
    public static String getTrackerId() throws LogTrackerException {
        Http.Context ctx;
        try {
            ctx = Http.Context.current();
        } catch (RuntimeException e) {
            ctx = LogTrackerUtil.context.get();
        }
        try {
            return ctx.args.get("TrackerId").toString();
        } catch (Exception e) {
            throw new LogTrackerException("Error occurred when getting the context", e);
        }
    }

    /**
     * Method to set the Http context
     * The context will be set to the ThreadLocal
     *
     * @param ctx Context to set
     * @throws LogTrackerException
     */
    public static void setContext(Http.Context ctx) throws LogTrackerException {
        try {
            LogTrackerUtil.context.set(ctx);
        } catch (Exception e) {
            throw new LogTrackerException("Error occurred when transferring the context", e);
        }
    }

    /**
     * Clear the context
     *
     */
    public static void clearContext() {
        LogTrackerUtil.context.remove();
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy