org.rvpf.base.logger

Class Logger

Object

Logger

All Implemented Interfaces:

Externalizable, Serializable, Thread.UncaughtExceptionHandler

@ThreadSafe
public class Logger
extends Object
implements Externalizable, Thread.UncaughtExceptionHandler

The Logger class provides an implementation independent interface to the logging facilities.

Support is provided for the messages resources and formatting classes. To minimize overhead, the resource access and text formatting is done just in time.

This class is serializable, but the serialization process only propagates the logger identification (name).

The current implementation is a thin wrapper over Log4J.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logger.LogLevel Log Level.
static interface	Logger.LogListener Log listener.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_KEY Diagnostic Context ID key.
static String	LOG_ID_PROPERTY Log ID property.
static String	MIDNIGHT_LOGGER_NAME Midnight logger name.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Logger() Constructs an instance.
protected	Logger(Class<?> ownerClass) Constructs an instance.
protected	Logger(Logger log4jLogger) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
static boolean	addListener(Logger.LogListener listener) Adds a listener for this logger.
static Optional<String>	currentLogID() Returns the current log ID.
void	debug(Message message) Logs a debug message.
void	debug(Messages.Entry entry, Object... params) Logs a debug message.
void	debug(String format, Object... params) Deprecated. For temporary use.
void	debug(Supplier<Message> messageSupplier) Logs a debug message.
void	debug(Throwable cause, Messages.Entry entry, Object... params) Logs a debug message.
void	debug(Throwable cause, String format, Object... params) Deprecated. For temporary use.
protected void	doLog(Logger.LogLevel logLevel, Message message) Logs a message.
void	error(Message message) Logs an error message.
void	error(Messages.Entry entry, Object... params) Logs an error message.
void	error(String format, Object... params) Deprecated. For temporary use.
void	error(Throwable cause, Messages.Entry entry, Object... params) Logs an error message.
void	error(Throwable cause, String format, Object... params) Deprecated. For temporary use.
void	fatal(Message message) Logs a fatal message.
void	fatal(Messages.Entry entry, Object... params) Logs a fatal message.
void	fatal(String format, Object... params) Deprecated. For temporary use.
void	fatal(Throwable cause, Messages.Entry entry, Object... params) Logs a fatal message.
void	fatal(Throwable cause, String format, Object... params) Deprecated. For temporary use.
static Logger	getInstance(Class<?> ownerClass) Gets a logger instance.
static Logger	getInstance(Logger log4jLogger) Gets a logger instance.
static Logger	getInstance(String name) Gets a logger instance.
protected Level	getLog4jLevel() Gets the log4j Level.
protected Logger	getLog4jLogger() Gets the log4j Logger.
Logger.LogLevel	getLogLevel() Gets the log level.
static Logger	getMidnightLogger() Gets the MIDNIGHT logger.
String	getName() Gets this logger's name.
PrintWriter	getPrintWriter(Logger.LogLevel logLevel) Gets a PrintWriter All messages sent to the PrintWriter will be processed according to the log level supplied here.
boolean	hasLogged(Logger.LogLevel logLevel) Asks if this has logged at least at the specified level.
void	info(Message message) Logs an info message.
void	info(Messages.Entry entry, Object... params) Logs an info message.
void	info(String format, Object... params) Deprecated. For temporary use.
void	info(Supplier<Message> messageSupplier) Logs an info message.
void	info(Throwable cause, Messages.Entry entry, Object... params) Logs an info message.
void	info(Throwable cause, String format, Object... params) Deprecated. For temporary use.
boolean	isDebugEnabled() Asks if the debug level is enabled.
boolean	isEnabledFor(Logger.LogLevel logLevel) Asks if a log level is enabled.
boolean	isInfoEnabled() Asks if the info level is enabled.
static boolean	isShutDown() Asks if logging is shut down.
boolean	isTraceEnabled() Asks if the trace level is enabled.
void	log(Logger.LogLevel logLevel, Message message) Logs a message.
void	log(Logger.LogLevel logLevel, Messages.Entry entry, Object... params) Logs a message.
void	log(Logger.LogLevel logLevel, String format, Object... params) Logs a message.
void	log(Logger.LogLevel logLevel, Supplier<Message> messageSupplier) Logs a debug message.
void	log(Logger.LogLevel logLevel, Throwable cause, Messages.Entry entry, Object... params) Logs a message.
void	log(Logger.LogLevel logLevel, Throwable cause, String format, Object... params) Logs a message.
static void	logBackEnd() Logs back end informations.
void	readExternal(ObjectInput input)
static boolean	removeListener(Logger.LogListener listener) Removes a listener for this logger.
void	reset() Resets the maximum level actually logged with this logger.
static void	restoreLogID(Optional<String> logID) Restores the log ID.
static void	setLogID() Sets the log ID to its default value.
static void	setLogID(Optional<String> logID) Sets the log ID.
static void	shutDown() Shuts down logging.
static void	startUp(boolean manualShutdown) Starts up logging.
void	trace(Message message) Logs a trace message.
void	trace(Messages.Entry entry, Object... params) Logs a trace message.
void	trace(String format, Object... params) Deprecated. For temporary use.
void	trace(Supplier<Message> messageSupplier) Logs a trace message.
void	trace(Throwable cause, Messages.Entry entry, Object... params) Logs a trace message.
void	trace(Throwable cause, String format, Object... params) Deprecated. For temporary use.
void	uncaughtException(Thread thread, Throwable throwable)
void	warn(Message message) Logs a warning message.
void	warn(Messages.Entry entry, Object... params) Logs a warning message.
void	warn(String format, Object... params) Deprecated. For temporary use.
void	warn(Throwable cause, Messages.Entry entry, Object... params) Logs a warning message.
void	warn(Throwable cause, String format, Object... params) Deprecated. For temporary use.
void	writeExternal(ObjectOutput output)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID_KEY

public static final String ID_KEY

Diagnostic Context ID key.

See Also:

Constant Field Values

LOG_ID_PROPERTY

public static final String LOG_ID_PROPERTY

Log ID property.

See Also:

Constant Field Values

MIDNIGHT_LOGGER_NAME

public static final String MIDNIGHT_LOGGER_NAME

Midnight logger name.

See Also:

Constant Field Values

Constructor Detail

Logger

public Logger()

Constructs an instance.

This is needed for an Externalizable implementation.

Logger

protected Logger(@Nonnull
                 Class<?> ownerClass)

Constructs an instance.

Parameters:

ownerClass - The owner class.

Logger

protected Logger(@Nonnull
                 Logger log4jLogger)

Constructs an instance.

Parameters:

log4jLogger - The 'org.apache.logging.log4j' Logger.

Method Detail

addListener

@CheckReturnValue
public static boolean addListener(@Nonnull
                                                     Logger.LogListener listener)

Adds a listener for this logger.

Parameters:

listener - The listener.

Returns:

True unless already added.

currentLogID

@Nonnull
 @CheckReturnValue
public static Optional<String> currentLogID()

Returns the current log ID.

Returns:

The log ID (may be empty).

getInstance

@Nonnull
 @CheckReturnValue
public static Logger getInstance(@Nonnull
                                                               Class<?> ownerClass)

Gets a logger instance.

Parameters:

ownerClass - The class of the logger's owner.

Returns:

The logger instance.

getInstance

@Nonnull
 @CheckReturnValue
public static Logger getInstance(@Nonnull
                                                               Logger log4jLogger)

Gets a logger instance.

This is used by scripts to supply their Log4j logger in calls to RVPF.

Parameters:

log4jLogger - A log4j logger.

Returns:

The logger instance.

getInstance

@Nonnull
 @CheckReturnValue
public static Logger getInstance(@Nonnull
                                                               String name)

Gets a logger instance.

Parameters:

name - The logger's name.

Returns:

The logger instance.

getMidnightLogger

@Nonnull
 @CheckReturnValue
public static Logger getMidnightLogger()

Gets the MIDNIGHT logger.

Returns:

The MIDNIGHT logger.

isShutDown

@CheckReturnValue
public static boolean isShutDown()

Asks if logging is shut down.

Returns:

True if logging is shut down.

logBackEnd

public static void logBackEnd()

Logs back end informations.

removeListener

@CheckReturnValue
public static boolean removeListener(@Nonnull
                                                        Logger.LogListener listener)

Removes a listener for this logger.

Parameters:

listener - The listener.

Returns:

True if it was present.

restoreLogID

public static void restoreLogID(@Nonnull
                                Optional<String> logID)

Restores the log ID.

If the log ID is empty, any previous value is removed.

Parameters:

logID - The log ID.

setLogID

public static void setLogID()

Sets the log ID to its default value.

setLogID

public static void setLogID(@Nonnull
                            Optional<String> logID)

Sets the log ID.

If the log ID is empty, a new value is generated.

Parameters:

logID - The log ID.

shutDown

public static void shutDown()

Shuts down logging.

startUp

public static void startUp(boolean manualShutdown)

Starts up logging.

Parameters:

manualShutdown - True if shutDown() will be called.

debug

public final void debug(@Nonnull
                        Message message)

Logs a debug message.

Parameters:

message - The message.

debug

public final void debug(@Nonnull
                        Supplier<Message> messageSupplier)

Logs a debug message.

Parameters:

messageSupplier - A message supplier.

debug

public final void debug(@Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs a debug message.

Parameters:

entry - The messages entry.

params - The message parameters.

debug

@Deprecated
public final void debug(@Nonnull
                                     String format,
                                     @Nonnull
                                     Object... params)

Deprecated. For temporary use.

Logs a debug message.

Parameters:

format - The message format.

params - The message parameters.

debug

public final void debug(@Nonnull
                        Throwable cause,
                        @Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs a debug message.

Parameters:

cause - The message cause.

entry - The messages entry.

params - The message parameters.

debug

@Deprecated
public final void debug(@Nonnull
                                     Throwable cause,
                                     @Nonnull
                                     String format,
                                     @Nonnull
                                     Object... params)

Deprecated. For temporary use.

Logs a debug message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

error

public final void error(@Nonnull
                        Message message)

Logs an error message.

Parameters:

message - The message.

error

public final void error(@Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs an error message.

Parameters:

entry - The messages entry.

params - The message parameters.

error

@Deprecated
public final void error(@Nonnull
                                     String format,
                                     @Nonnull
                                     Object... params)

Deprecated. For temporary use.

Logs an error message.

Parameters:

format - The message format.

params - The message parameters.

error

public final void error(@Nonnull
                        Throwable cause,
                        @Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs an error message.

Parameters:

cause - The message cause.

entry - The messages entry.

params - The message parameters.

error

@Deprecated
public final void error(@Nonnull
                                     Throwable cause,
                                     @Nonnull
                                     String format,
                                     @Nonnull
                                     Object... params)

Deprecated. For temporary use.

Logs an error message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

fatal

public final void fatal(@Nonnull
                        Message message)

Logs a fatal message.

Parameters:

message - The message.

fatal

public final void fatal(@Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs a fatal message.

Parameters:

entry - The messages entry.

params - The message parameters.

fatal

@Deprecated
public final void fatal(@Nonnull
                                     String format,
                                     @Nonnull
                                     Object... params)

Deprecated. For temporary use.

Logs a fatal message.

Parameters:

format - The message format.

params - The message parameters.

fatal

public final void fatal(@Nonnull
                        Throwable cause,
                        @Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs a fatal message.

Parameters:

cause - The message cause.

entry - The messages entry.

params - The message parameters.

fatal

@Deprecated
public final void fatal(@Nonnull
                                     Throwable cause,
                                     @Nonnull
                                     String format,
                                     @Nonnull
                                     Object... params)

Deprecated. For temporary use.

Logs a fatal message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

getLogLevel

@Nonnull
 @CheckReturnValue
public final Logger.LogLevel getLogLevel()

Gets the log level.

Returns:

The log level.

getName

@Nonnull
 @CheckReturnValue
public final String getName()

Gets this logger's name.

Returns:

This logger's name.

getPrintWriter

@Nonnull
 @CheckReturnValue
public final PrintWriter getPrintWriter(@Nonnull
                                                                      Logger.LogLevel logLevel)

Gets a PrintWriter

All messages sent to the PrintWriter will be processed according to the log level supplied here.

Parameters:

logLevel - The log level.

Returns:

A PrintWriter.

hasLogged

@CheckReturnValue
public final boolean hasLogged(@Nonnull
                                                  Logger.LogLevel logLevel)

Asks if this has logged at least at the specified level.

Parameters:

logLevel - A LogLevel.

Returns:

True if it has logged at least at the specified level.

See Also:

reset()

info

public final void info(@Nonnull
                       Message message)

Logs an info message.

Parameters:

message - The message.

info

public final void info(@Nonnull
                       Supplier<Message> messageSupplier)

Logs an info message.

Parameters:

messageSupplier - A message supplier.

info

public final void info(@Nonnull
                       Messages.Entry entry,
                       @Nonnull
                       Object... params)

Logs an info message.

Parameters:

entry - The messages entry.

params - The message parameters.

info

@Deprecated
public final void info(@Nonnull
                                    String format,
                                    @Nonnull
                                    Object... params)

Deprecated. For temporary use.

Logs an info message.

Parameters:

format - The message format.

params - The message parameters.

info

public final void info(@Nonnull
                       Throwable cause,
                       @Nonnull
                       Messages.Entry entry,
                       @Nonnull
                       Object... params)

Logs an info message.

Parameters:

cause - The message cause.

entry - The messages entry.

params - The message parameters.

info

@Deprecated
public final void info(@Nonnull
                                    Throwable cause,
                                    @Nonnull
                                    String format,
                                    @Nonnull
                                    Object... params)

Deprecated. For temporary use.

Logs an info message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

isDebugEnabled

@CheckReturnValue
public final boolean isDebugEnabled()

Asks if the debug level is enabled.

Returns:

True if enabled.

isEnabledFor

@CheckReturnValue
public final boolean isEnabledFor(Logger.LogLevel logLevel)

Asks if a log level is enabled.

Parameters:

logLevel - The log level.

Returns:

True if enabled.

isInfoEnabled

@CheckReturnValue
public final boolean isInfoEnabled()

Asks if the info level is enabled.

Returns:

True if enabled.

isTraceEnabled

@CheckReturnValue
public final boolean isTraceEnabled()

Asks if the trace level is enabled.

Returns:

True if enabled.

log

public final void log(@Nonnull
                      Logger.LogLevel logLevel,
                      @Nonnull
                      Message message)

Logs a message.

Parameters:

logLevel - The log level.

message - The message.

log

public final void log(@Nonnull
                      Logger.LogLevel logLevel,
                      @Nonnull
                      Supplier<Message> messageSupplier)

Logs a debug message.

Parameters:

logLevel - The log level.

messageSupplier - A message supplier.

log

public final void log(@Nonnull
                      Logger.LogLevel logLevel,
                      @Nonnull
                      Messages.Entry entry,
                      @Nonnull
                      Object... params)

Logs a message.

Parameters:

logLevel - The log level.

entry - The messages entry.

params - The message parameters.

log

public final void log(@Nonnull
                      Logger.LogLevel logLevel,
                      @Nonnull
                      String format,
                      @Nonnull
                      Object... params)

Logs a message.

Parameters:

logLevel - The log level.

format - The message format.

params - The message parameters.

log

public final void log(@Nonnull
                      Logger.LogLevel logLevel,
                      @Nonnull
                      Throwable cause,
                      @Nonnull
                      Messages.Entry entry,
                      @Nonnull
                      Object... params)

Logs a message.

Parameters:

logLevel - The log level.

cause - The message cause.

entry - The messages entry.

params - The message parameters.

log

public final void log(@Nonnull
                      Logger.LogLevel logLevel,
                      @Nonnull
                      Throwable cause,
                      @Nonnull
                      String format,
                      @Nonnull
                      Object... params)

Logs a message.

Parameters:

logLevel - The log level.

cause - The message cause.

format - The message format.

params - The message parameters.

readExternal

public final void readExternal(@Nonnull
                               ObjectInput input)
                        throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

reset

public final void reset()

Resets the maximum level actually logged with this logger.

See Also:

hasLogged(org.rvpf.base.logger.Logger.LogLevel)

trace

public final void trace(@Nonnull
                        Message message)

Logs a trace message.

Parameters:

message - The message.

trace

public final void trace(@Nonnull
                        Supplier<Message> messageSupplier)

Logs a trace message.

Parameters:

messageSupplier - A message supplier.

trace

public final void trace(@Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs a trace message.

Parameters:

entry - The messages entry.

params - The message parameters.

trace

@Deprecated
public final void trace(@Nonnull
                                     String format,
                                     @Nonnull
                                     Object... params)

Deprecated. For temporary use.

Logs a trace message.

Parameters:

format - The message format.

params - The message parameters.

trace

public final void trace(@Nonnull
                        Throwable cause,
                        @Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs a trace message.

Parameters:

cause - The message cause.

entry - The messages entry.

params - The message parameters.

trace

@Deprecated
public final void trace(@Nonnull
                                     Throwable cause,
                                     @Nonnull
                                     String format,
                                     @Nonnull
                                     Object... params)

Deprecated. For temporary use.

Logs a trace message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

uncaughtException

public final void uncaughtException(@Nonnull
                                    Thread thread,
                                    @Nonnull
                                    Throwable throwable)

Specified by:

uncaughtException in interface Thread.UncaughtExceptionHandler

warn

public final void warn(@Nonnull
                       Message message)

Logs a warning message.

Parameters:

message - The message.

warn

public final void warn(@Nonnull
                       Messages.Entry entry,
                       @Nonnull
                       Object... params)

Logs a warning message.

Parameters:

entry - The messages entry.

params - The message parameters.

warn

@Deprecated
public final void warn(@Nonnull
                                    String format,
                                    @Nonnull
                                    Object... params)

Deprecated. For temporary use.

Logs a warning message.

Parameters:

format - The message format.

params - The message parameters.

warn

public final void warn(@Nonnull
                       Throwable cause,
                       @Nonnull
                       Messages.Entry entry,
                       @Nonnull
                       Object... params)

Logs a warning message.

Parameters:

cause - The message cause.

entry - The messages entry.

params - The message parameters.

warn

@Deprecated
public final void warn(@Nonnull
                                    Throwable cause,
                                    @Nonnull
                                    String format,
                                    @Nonnull
                                    Object... params)

Deprecated. For temporary use.

Logs a warning message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

writeExternal

public final void writeExternal(@Nonnull
                                ObjectOutput output)
                         throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

doLog

protected void doLog(@Nonnull
                     Logger.LogLevel logLevel,
                     @Nonnull
                     Message message)

Logs a message.

Parameters:

logLevel - The log level.

message - The message.

getLog4jLevel

@Nonnull
 @CheckReturnValue
protected final Level getLog4jLevel()

Gets the log4j Level.

Returns:

The log4j Level.

getLog4jLogger

@Nonnull
 @CheckReturnValue
protected final Logger getLog4jLogger()

Gets the log4j Logger.

Returns:

The log4j Logger.