org.owasp.esapi.interfaces
Interface ILogger

All Known Implementing Classes:

Logger

public interface ILogger

The ILogger interface defines a set of methods that can be used to log security events. Implementors should use a well established logging library as it is quite difficult to create a high-performance logger.

The order of logging levels is:

• trace
• debug
• info
• warn
• error
• fatal (the most serious)

Since:

June 1, 2007

Author:

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

Field Summary

static java.lang.String	PERFORMANCE The PERFORMANCE.
static java.lang.String	SECURITY The SECURITY.
static java.lang.String	USABILITY The USABILITY.

Method Summary

void	debug(java.lang.String type, java.lang.String message) Log debug.
void	debug(java.lang.String type, java.lang.String message, java.lang.Throwable throwable) Log debug.
void	error(java.lang.String type, java.lang.String message) Log error.
void	error(java.lang.String type, java.lang.String message, java.lang.Throwable throwable) Log error.
void	fatal(java.lang.String type, java.lang.String message) Log critical.
void	fatal(java.lang.String type, java.lang.String message, java.lang.Throwable throwable) Log critical.
void	info(java.lang.String type, java.lang.String message) Log success.
void	info(java.lang.String type, java.lang.String message, java.lang.Throwable throwable) Log success.
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	trace(java.lang.String type, java.lang.String message) Log trace.
void	trace(java.lang.String type, java.lang.String message, java.lang.Throwable throwable) Log trace.
void	warning(java.lang.String type, java.lang.String message) Log warning.
void	warning(java.lang.String type, java.lang.String message, java.lang.Throwable throwable) Log warning.

Field Detail

SECURITY

public static final java.lang.String SECURITY

The SECURITY.

See Also:

Constant Field Values

USABILITY

public static final java.lang.String USABILITY

The USABILITY.

See Also:

Constant Field Values

PERFORMANCE

public static final java.lang.String PERFORMANCE

The PERFORMANCE.

See Also:

Constant Field Values

Method Detail

fatal

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

Log critical.

Parameters:

type - the type

message - the message

fatal

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

Log critical.

Parameters:

type - the type

message - the message

throwable - the throwable

isFatalEnabled

public boolean isFatalEnabled()

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

Returns:

true if messages will be output to the log

debug

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

Log debug.

Parameters:

type - the type

message - the message

debug

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

Log debug.

Parameters:

type - the type

message - the message

throwable - the throwable

isDebugEnabled

public boolean isDebugEnabled()

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

Returns:

true if messages will be output to the log

error

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

Log error.

Parameters:

type - the type

message - the message

error

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

Log error.

Parameters:

type - the type

message - the message

throwable - the throwable

isErrorEnabled

public boolean isErrorEnabled()

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

Returns:

true if messages will be output to the log

info

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

Log success.

Parameters:

type - the type

message - the message

info

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

Log success.

Parameters:

type - the type

message - the message

throwable - the throwable

isInfoEnabled

public boolean isInfoEnabled()

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

Returns:

true if messages will be output to the log

trace

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

Log trace.

Parameters:

type - the type

message - the message

trace

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

Log trace.

Parameters:

type - the type

message - the message

throwable - the throwable

isTraceEnabled

public boolean isTraceEnabled()

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

Returns:

true if messages will be output to the log

warning

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

Log warning.

Parameters:

type - the type

message - the message

warning

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

Log warning.

Parameters:

type - the type

message - the message

throwable - the throwable

isWarningEnabled

public boolean isWarningEnabled()

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

Returns:

true if messages will be output to the log