org.adroitlogic.x.logging

Class LoggerFactory

java.lang.Object

org.adroitlogic.x.logging.LoggerFactory

public final class LoggerFactory
extends Object

The LoggerFactory providing instances of loggers as and when required. The Logger instances returned by this factory are immutable and hence it will always be retuning the same object for identical parameters. So it is safe to use the LoggerFactory.getLogger(parameters) multiple times to acquire the logger, as that will not result in any new object creation

This behavior makes it usable in mediation where the state is not managed (such as Java fragment sequences), where it could get a reference to the logger in each and every message, which will return the same object for all the messages.

The loggers returned by this factory supports few built-in MDC like arguments. The set of MDC arguments include;

The built-in MDC attributes

MDC Key	Contextual Value
xs	The default status code of the logger which is used unless a contextual status code is not provided

Since:

17.01

Author:

Ruwan Linton

See Also:

Logger

Constructor Summary

Constructors

Constructor and Description
LoggerFactory()

Method Summary

Modifier and Type	Method and Description
static Logger	getExistingLogger(String name) Returns an existing logger from the cache without creating a new logger on absence
static Logger	getLogger(Class<?> clazz)
static Logger	getLogger(String name, int componentType, int moduleId, int loggerId) Gives an immutable Logger representing the given logger name and following extension point values.
static void	shutdown() Shuts down the underlying logging framework

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggerFactory

public LoggerFactory()

Method Detail

getLogger

public static Logger getLogger(String name,
                               int componentType,
                               int moduleId,
                               int loggerId)

Gives an immutable Logger representing the given logger name and following extension point values.

Parameters:

name - the name of the logger to be acquired

componentType - the component type of the logger, which can be one of [0..9] as per ComponentType

moduleId - the module id which is a 3 digit number

loggerId - the logger id which is a 2 digit number

Returns:

immutable logger instance for the given name and other parameters

getExistingLogger

public static Logger getExistingLogger(String name)

Returns an existing logger from the cache without creating a new logger on absence

Parameters:

name - the name of the logger to be acquired

Returns:

existing logger instance for the given name, null on absence

getLogger

public static Logger getLogger(Class<?> clazz)

shutdown

public static void shutdown()

Shuts down the underlying logging framework