org.broadleafcommerce.common.logging

Class SupportLogger

java.lang.Object

org.broadleafcommerce.common.logging.SupportLogger

public class SupportLogger
extends java.lang.Object

SupportLogger class that provides support for the new SUPPORT log level type. The SUPPORT log level is independent of any configured logging framework and should be able to be configured independently.

This Logger was originally built as an extension to Log4j's Logger. As a result, other levels must be supported to maintain backwards compatibility.

It is important to note that the SupportLogger can be called outside a Spring Context. Therefore, it is possible to instantiate a different SupportLogger adapter using the fully qualified class name of an implementation using a System Property. By default, it will instantiate a SystemSupportLoggerAdapter if none is specified. For example, you may wish to disable all logs made to the Support Logger by setting the following System Property:

• -DSupportLogger.adapter.fqcn=org.broadleafcommerce.common.logging.DisableSupportLoggerAdapter

The main requirements for SUPPORT level logging are to:

• show up in the logs as a SUPPORT item (not ERROR or WARN etc...)
• always show up unless configured otherwise, as we want users to always see SUPPORT messages
• allow state messages to be associated with the log (e.g. “Enterprise Module — …”)

Author:

Jeff Fischer, elbertbautista

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FQCN_KEY

Constructor Summary

Constructors

Constructor and Description
SupportLogger(java.lang.String moduleName, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.Object message) In order to be backwards compatible.
void	debug(java.lang.Object message, java.lang.Throwable t)
void	error(java.lang.Object message)
void	error(java.lang.Object message, java.lang.Throwable t)
void	fatal(java.lang.Object message)
void	fatal(java.lang.Object message, java.lang.Throwable t)
static java.lang.String	getSupportLoggerAdapterFQCN()
void	info(java.lang.Object message)
void	info(java.lang.Object message, java.lang.Throwable t)
void	lifecycle(LifeCycleEvent lifeCycleEvent, java.lang.Object message) emit a SUPPORT lifecycle message
void	support(java.lang.Object message) emit a SUPPORT level message
void	support(java.lang.Object message, java.lang.Throwable t) emit a SUPPORT level message with throwable
void	warn(java.lang.Object message)
void	warn(java.lang.Object message, java.lang.Throwable t)

Methods inherited from class java.lang.Object

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

Field Detail

FQCN_KEY

public static final java.lang.String FQCN_KEY

See Also:

Constant Field Values

Constructor Detail

SupportLogger

public SupportLogger(java.lang.String moduleName,
                     java.lang.String name)

Method Detail

support

public void support(java.lang.Object message)

emit a SUPPORT level message

Parameters:

message -

support

public void support(java.lang.Object message,
                    java.lang.Throwable t)

emit a SUPPORT level message with throwable

Parameters:

message -

t -

lifecycle

public void lifecycle(LifeCycleEvent lifeCycleEvent,
                      java.lang.Object message)

emit a SUPPORT lifecycle message

Parameters:

lifeCycleEvent -

message -

debug

public void debug(java.lang.Object message)

In order to be backwards compatible. The support logger should also support the debug, error, fatal, info, and warn levels as well.

Parameters:

message -

debug

public void debug(java.lang.Object message,
                  java.lang.Throwable t)

error

public void error(java.lang.Object message)

error

public void error(java.lang.Object message,
                  java.lang.Throwable t)

fatal

public void fatal(java.lang.Object message)

fatal

public void fatal(java.lang.Object message,
                  java.lang.Throwable t)

info

public void info(java.lang.Object message)

info

public void info(java.lang.Object message,
                 java.lang.Throwable t)

warn

public void warn(java.lang.Object message)

warn

public void warn(java.lang.Object message,
                 java.lang.Throwable t)

getSupportLoggerAdapterFQCN

public static java.lang.String getSupportLoggerAdapterFQCN()