org.broadleafcommerce.common.logging

Class SystemSupportLoggerAdapter

java.lang.Object

org.broadleafcommerce.common.logging.AbstractSupportLoggerAdapter

org.broadleafcommerce.common.logging.SystemSupportLoggerAdapter

All Implemented Interfaces:

SupportLoggerAdapter

public class SystemSupportLoggerAdapter
extends AbstractSupportLoggerAdapter
implements SupportLoggerAdapter

Default Implementation of SupportLoggerAdapter that sends all support log messages to the console (System.out). The following System Properties are supported to configure the behavior of this logger:

• SystemSupportLoggerAdapter.showDateTime - Set to true if you want the current date and time to be included in output messages. Default is true
• SystemSupportLoggerAdapter.dateTimeFormat - The date and time format to be used in the output messages. The pattern describing the date and time format is defined by SimpleDateFormat. If the format is not specified or is invalid, the number of milliseconds since start up will be output.
• SystemSupportLoggerAdapter.showThreadName - Set to true if you want to output the current thread name. Defaults to false.
• SystemSupportLoggerAdapter.showLogName - Set to true if you want the Logger instance name to be included in output messages. Defaults to true.
• SystemSupportLoggerAdapter.levelInBrackets - Should the level string be output in brackets? Defaults to true.
• SystemSupportLoggerAdapter.showNonSupportLevels - Show non-support level logs (i.e. DEBUG, ERROR, FATAL, INFO, WARN) Defaults to false.

This implementation is heavily inspired by SLF4J's SimpleLogger.

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_TIME_FORMAT_KEY
static String	LEVEL_IN_BRACKETS_KEY
static String	SHOW_DATE_TIME_KEY
static String	SHOW_LOG_NAME_KEY
static String	SHOW_NON_SUPPORT_LEVELS_KEY
static String	SHOW_THREAD_NAME_KEY

Fields inherited from class org.broadleafcommerce.common.logging.AbstractSupportLoggerAdapter

DEBUG, ERROR, FATAL, INFO, LOG_LEVEL_DEBUG, LOG_LEVEL_ERROR, LOG_LEVEL_FATAL, LOG_LEVEL_INFO, LOG_LEVEL_SUPPORT, LOG_LEVEL_TRACE, LOG_LEVEL_WARN, SUPPORT, TRACE, WARN

Constructor Summary

Constructors

Constructor and Description
SystemSupportLoggerAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	debug(String message) In order to be backwards compatible.
void	debug(String message, Throwable t)
void	error(String message)
void	error(String message, Throwable t)
void	fatal(String message)
void	fatal(String message, Throwable t)
protected DateFormat	getDateFormatter()
protected String	getFormattedDate()
protected boolean	getLevelInBrackets()
String	getName()
protected boolean	getShowDateTime()
protected boolean	getShowLogName()
protected boolean	getShowNonSupportLevels()
protected boolean	getShowThreadName()
void	info(String message)
void	info(String message, Throwable t)
void	lifecycle(LifeCycleEvent lifeCycleEvent, String message) Generate a specialized SUPPORT level log message that includes a LifeCycleEvent in the message.
protected void	log(int level, String message, Throwable t)
void	setName(String name)
void	support(String message) Generate a SUPPORT level log message
void	support(String message, Throwable t) Generate a SUPPORT level log message with an accompanying Throwable
void	warn(String message)
void	warn(String message, Throwable t)
protected void	write(StringBuffer buf, Throwable t)

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_DATE_TIME_KEY

public static final String SHOW_DATE_TIME_KEY

See Also:

Constant Field Values

DATE_TIME_FORMAT_KEY

public static final String DATE_TIME_FORMAT_KEY

See Also:

Constant Field Values

SHOW_THREAD_NAME_KEY

public static final String SHOW_THREAD_NAME_KEY

See Also:

Constant Field Values

SHOW_LOG_NAME_KEY

public static final String SHOW_LOG_NAME_KEY

See Also:

Constant Field Values

LEVEL_IN_BRACKETS_KEY

public static final String LEVEL_IN_BRACKETS_KEY

See Also:

Constant Field Values

SHOW_NON_SUPPORT_LEVELS_KEY

public static final String SHOW_NON_SUPPORT_LEVELS_KEY

See Also:

Constant Field Values

Constructor Detail

SystemSupportLoggerAdapter

public SystemSupportLoggerAdapter()

Method Detail

support

public void support(String message)

Generate a SUPPORT level log message

Specified by:

support in interface SupportLoggerAdapter

Parameters:

message - the log message

support

public void support(String message,
           Throwable t)

Generate a SUPPORT level log message with an accompanying Throwable

Specified by:

support in interface SupportLoggerAdapter

Parameters:

message - the log message

t - the exception to accompany the log message - will result in a stack track in the log

lifecycle

public void lifecycle(LifeCycleEvent lifeCycleEvent,
             String message)

Generate a specialized SUPPORT level log message that includes a LifeCycleEvent in the message.

Specified by:

lifecycle in interface SupportLoggerAdapter

Parameters:

lifeCycleEvent - The module life cycle type for this log message

message - the log message

debug

public void debug(String message)

Description copied from interface: SupportLoggerAdapter

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

Specified by:

debug in interface SupportLoggerAdapter

debug

public void debug(String message,
         Throwable t)

Specified by:

debug in interface SupportLoggerAdapter

error

public void error(String message)

Specified by:

error in interface SupportLoggerAdapter

error

public void error(String message,
         Throwable t)

Specified by:

error in interface SupportLoggerAdapter

fatal

public void fatal(String message)

Specified by:

fatal in interface SupportLoggerAdapter

fatal

public void fatal(String message,
         Throwable t)

Specified by:

fatal in interface SupportLoggerAdapter

info

public void info(String message)

Specified by:

info in interface SupportLoggerAdapter

info

public void info(String message,
        Throwable t)

Specified by:

info in interface SupportLoggerAdapter

warn

public void warn(String message)

Specified by:

warn in interface SupportLoggerAdapter

warn

public void warn(String message,
        Throwable t)

Specified by:

warn in interface SupportLoggerAdapter

log

protected void log(int level,
       String message,
       Throwable t)

write

protected void write(StringBuffer buf,
         Throwable t)

getFormattedDate

protected String getFormattedDate()

getShowDateTime

protected boolean getShowDateTime()

getDateFormatter

protected DateFormat getDateFormatter()

getShowThreadName

protected boolean getShowThreadName()

getShowLogName

protected boolean getShowLogName()

getLevelInBrackets

protected boolean getLevelInBrackets()

getShowNonSupportLevels

protected boolean getShowNonSupportLevels()

getName

public String getName()

Specified by:

getName in interface SupportLoggerAdapter

setName

public void setName(String name)

Specified by:

setName in interface SupportLoggerAdapter