sirius.kernel.health.LogMessage Maven / Gradle / Ivy

Go to download
/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.kernel.health;

import org.apache.log4j.Level;
import sirius.kernel.nls.NLS;

import java.time.Instant;

/**
 * Contains a log message passed from {@link Log} to {@link LogTap}.
 */
public class LogMessage {
    private String message;
    private long timestamp;
    private Level logLevel;
    private Log receiver;
    boolean receiverWouldLog;
    private String thread;

    /**
     * Creates a new log message based on the given parameters.
     *
     * @param message          the message to log
     * @param logLevel         the level of the message
     * @param receiver         the original receiver
     * @param receiverWouldLog determines if the receiver would have logged the message
     * @param thread           the thread in which the message was logged
     */
    public LogMessage(String message, Level logLevel, Log receiver, boolean receiverWouldLog, String thread) {
        this.thread = thread;
        this.timestamp = System.currentTimeMillis();
        this.message = message;
        this.logLevel = logLevel;
        this.receiver = receiver;
        this.receiverWouldLog = receiverWouldLog;
    }

    /**
     * Contains the logged message.
     *
     * @return the message sent to the logger
     */
    public String getMessage() {
        return message;
    }

    /**
     * Contains the log level used for this message.
     *
     * @return the log level of this message
     */
    public Level getLogLevel() {
        return logLevel;
    }

    /**
     * Returns the logger used to handle this message.
     *
     * @return the logger used to handle this message
     */
    public Log getReceiver() {
        return receiver;
    }

    /**
     * Returns whether the receiver has logged this message.
     *
     * @return whether the receiver has logged this message
     */
    public boolean isReceiverWouldLog() {
        return receiverWouldLog;
    }

    /**
     * Returns the timestamp when this message was created as string.
     *
     * @return the timestamp when this message was created, formatted as string
     */
    public String getTimestampAsString() {
        return NLS.toUserString(Instant.ofEpochMilli(timestamp));
    }

    /**
     * Returns the timestamp when this message was created.
     *
     * @return the timestamp when this message was created
     */
    public long getTimestamp() {
        return timestamp;
    }

    /**
     * Returns the name of the thread which logged the message.
     *
     * @return the name of the thread which logged the message
     */
    public String getThread() {
        return thread;
    }
}