org.owasp.esapi.reference
Class Log4JLogFactory.Log4JLogger

java.lang.Object
  org.owasp.esapi.reference.Log4JLogFactory.Log4JLogger

All Implemented Interfaces:

Logger

Direct Known Subclasses:

ExampleExtendedLog4JLogFactory.ExampleExtendedLog4JLogger

Enclosing class:

Log4JLogFactory

protected static class Log4JLogFactory.Log4JLogger
extends java.lang.Object
implements Logger

Reference implementation of the Logger interface. It implements most of the recommendations defined in the Logger interface description. It does not filter out any sensitive data specific to the current application or organization, such as credit cards, social security numbers, etc.

Since:

June 1, 2007

Author:

Jeff Williams (jeff.williams .at. aspectsecurity.com) Aspect Security

See Also:

LogFactory

Nested Class Summary

Nested classes/interfaces inherited from interface org.owasp.esapi.Logger

Logger.EventType

Field Summary

Fields inherited from interface org.owasp.esapi.Logger

ALL, DEBUG, ERROR, EVENT_FAILURE, EVENT_SUCCESS, FATAL, INFO, OFF, SECURITY_FAILURE, SECURITY_SUCCESS, TRACE, WARNING

Constructor Summary

protected

Log4JLogFactory.Log4JLogger(java.lang.String moduleName) Public constructor should only ever be called via the appropriate LogFactory

Method Summary

void	debug(Logger.EventType type, java.lang.String message) Log a debug level security event if 'debug' level logging is enabled.
void	debug(Logger.EventType type, java.lang.String message, java.lang.Throwable throwable) Log a debug level security event if 'debug' level logging is enabled and also record the stack trace associated with the event.
void	error(Logger.EventType type, java.lang.String message) Log an error level security event if 'error' level logging is enabled.
void	error(Logger.EventType type, java.lang.String message, java.lang.Throwable throwable) Log an error level security event if 'error' level logging is enabled and also record the stack trace associated with the event.
void	fatal(Logger.EventType type, java.lang.String message) Log a fatal event if 'fatal' level logging is enabled.
void	fatal(Logger.EventType type, java.lang.String message, java.lang.Throwable throwable) Log a fatal level security event if 'fatal' level logging is enabled and also record the stack trace associated with the event.
java.lang.String	getUserInfo()
void	info(Logger.EventType type, java.lang.String message) Log an info level security event if 'info' level logging is enabled.
void	info(Logger.EventType type, java.lang.String message, java.lang.Throwable throwable) Log an info level security event if 'info' level logging is enabled and also record the stack trace associated with the event.
boolean	isDebugEnabled() Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.
boolean	isErrorEnabled() Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.
boolean	isFatalEnabled() Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.
boolean	isInfoEnabled() Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.
boolean	isTraceEnabled() Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.
boolean	isWarningEnabled() Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.
void	setLevel(int level) Dynamically set the logging severity level.
void	trace(Logger.EventType type, java.lang.String message) Log a trace level security event if 'trace' level logging is enabled.
void	trace(Logger.EventType type, java.lang.String message, java.lang.Throwable throwable) Log a trace level security event if 'trace' level logging is enabled and also record the stack trace associated with the event.
void	warning(Logger.EventType type, java.lang.String message) Log a warning level security event if 'warning' level logging is enabled.
void	warning(Logger.EventType type, java.lang.String message, java.lang.Throwable throwable) Log a warning level security event if 'warning' level logging is enabled and also record the stack trace associated with the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

Log4JLogFactory.Log4JLogger

protected Log4JLogFactory.Log4JLogger(java.lang.String moduleName)

Public constructor should only ever be called via the appropriate LogFactory

Parameters:

moduleName - the module name

Method Detail

setLevel

public void setLevel(int level)

Dynamically set the logging severity level. All events of this level and higher will be logged from this point forward for all logs. All events below this level will be discarded. Note: In this implementation, this change is not persistent, meaning that if the application is restarted, the log level will revert to the level defined in the ESAPI SecurityConfiguration properties file.

Specified by:

setLevel in interface Logger

Parameters:

level - The level to set the logging level to.

trace

public void trace(Logger.EventType type,
                  java.lang.String message,
                  java.lang.Throwable throwable)

Log a trace level security event if 'trace' level logging is enabled and also record the stack trace associated with the event.

Specified by:

trace in interface Logger

Parameters:

type - the type of event

message - the message to log

throwable - the exception to be logged

trace

public void trace(Logger.EventType type,
                  java.lang.String message)

Log a trace level security event if 'trace' level logging is enabled.

Specified by:

trace in interface Logger

Parameters:

type - the type of event

message - the message to log

debug

public void debug(Logger.EventType type,
                  java.lang.String message,
                  java.lang.Throwable throwable)

Log a debug level security event if 'debug' level logging is enabled and also record the stack trace associated with the event.

Specified by:

debug in interface Logger

Parameters:

type - the type of event

message - the message to log

throwable - the exception to be logged

debug

public void debug(Logger.EventType type,
                  java.lang.String message)

Log a debug level security event if 'debug' level logging is enabled.

Specified by:

debug in interface Logger

Parameters:

type - the type of event

message - the message to log

info

public void info(Logger.EventType type,
                 java.lang.String message)

Log an info level security event if 'info' level logging is enabled.

Specified by:

info in interface Logger

Parameters:

type - the type of event

message - the message to log

info

public void info(Logger.EventType type,
                 java.lang.String message,
                 java.lang.Throwable throwable)

Log an info level security event if 'info' level logging is enabled and also record the stack trace associated with the event.

Specified by:

info in interface Logger

Parameters:

type - the type of event

message - the message to log

throwable - the exception to be logged

warning

public void warning(Logger.EventType type,
                    java.lang.String message,
                    java.lang.Throwable throwable)

Log a warning level security event if 'warning' level logging is enabled and also record the stack trace associated with the event.

Specified by:

warning in interface Logger

Parameters:

type - the type of event

message - the message to log

throwable - the exception to be logged

warning

public void warning(Logger.EventType type,
                    java.lang.String message)

Log a warning level security event if 'warning' level logging is enabled.

Specified by:

warning in interface Logger

Parameters:

type - the type of event

message - the message to log

error

public void error(Logger.EventType type,
                  java.lang.String message,
                  java.lang.Throwable throwable)

Log an error level security event if 'error' level logging is enabled and also record the stack trace associated with the event.

Specified by:

error in interface Logger

Parameters:

type - the type of event

message - the message to log

throwable - the exception to be logged

error

public void error(Logger.EventType type,
                  java.lang.String message)

Log an error level security event if 'error' level logging is enabled.

Specified by:

error in interface Logger

Parameters:

type - the type of event

message - the message to log

fatal

public void fatal(Logger.EventType type,
                  java.lang.String message,
                  java.lang.Throwable throwable)

Log a fatal level security event if 'fatal' level logging is enabled and also record the stack trace associated with the event.

Specified by:

fatal in interface Logger

Parameters:

type - the type of event

message - the message to log

throwable - the exception to be logged

fatal

public void fatal(Logger.EventType type,
                  java.lang.String message)

Log a fatal event if 'fatal' level logging is enabled.

Specified by:

fatal in interface Logger

Parameters:

type - the type of event

message - the message to log

isDebugEnabled

public boolean isDebugEnabled()

Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.

Specified by:

isDebugEnabled in interface Logger

Returns:

true if debug level messages will be output to the log

isErrorEnabled

public boolean isErrorEnabled()

Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.

Specified by:

isErrorEnabled in interface Logger

Returns:

true if error level messages will be output to the log

isFatalEnabled

public boolean isFatalEnabled()

Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.

Specified by:

isFatalEnabled in interface Logger

Returns:

true if fatal level messages will be output to the log

isInfoEnabled

public boolean isInfoEnabled()

Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.

Specified by:

isInfoEnabled in interface Logger

Returns:

true if info level messages will be output to the log

isTraceEnabled

public boolean isTraceEnabled()

Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.

Specified by:

isTraceEnabled in interface Logger

Returns:

true if trace level messages will be output to the log

isWarningEnabled

public boolean isWarningEnabled()

Allows the caller to determine if messages logged at this level will be discarded, to avoid performing expensive processing.

Specified by:

isWarningEnabled in interface Logger

Returns:

true if warning level messages will be output to the log

getUserInfo

public java.lang.String getUserInfo()