public interface Logger
The logging levels defined by this interface (in descending order) are:
always()
methods that will always
log a message regardless of the log level.
ESAPI also allows for the definition of the type of log event that is being generated. The Logger interface predefines 6 types of Log events:
Your implementation can extend or change this list if desired.
This Logger allows callers to determine which logging levels are enabled, and to submit events
at different severity levels.
Implementors of this interface should:
Modifier and Type | Interface and Description |
---|---|
static class |
Logger.EventType
Defines the type of log event that is being generated.
|
Modifier and Type | Field and Description |
---|---|
static int |
ALL
ALL indicates that all messages should be logged.
|
static int |
DEBUG
DEBUG indicates that DEBUG messages and above should be logged.
|
static int |
ERROR
ERROR indicates that ERROR messages and above should be logged.
|
static Logger.EventType |
EVENT_FAILURE
A non-security type of log event that has failed.
|
static Logger.EventType |
EVENT_SUCCESS
A non-security type of log event that has succeeded.
|
static Logger.EventType |
EVENT_UNSPECIFIED
A non-security type of log event that is unspecified.
|
static int |
FATAL
FATAL indicates that only FATAL messages should be logged.
|
static int |
INFO
INFO indicates that INFO messages and above should be logged.
|
static int |
OFF
OFF indicates that no messages should be logged.
|
static Logger.EventType |
SECURITY_AUDIT
A security type of log event that is associated with an audit trail of some type,
but the log event is not specifically something that has either succeeded or failed
or that is irrelevant in the case of this logged message.
|
static Logger.EventType |
SECURITY_FAILURE
A security type of log event that has failed.
|
static Logger.EventType |
SECURITY_SUCCESS
A security type of log event that has succeeded.
|
static int |
TRACE
TRACE indicates that TRACE messages and above should be logged.
|
static int |
WARNING
WARNING indicates that WARNING messages and above should be logged.
|
Modifier and Type | Method and Description |
---|---|
void |
always(Logger.EventType type,
String message)
Log an event regardless of what logging level is enabled.
|
void |
always(Logger.EventType type,
String message,
Throwable throwable)
Log an event regardless of what logging level is enabled
and also record the stack trace associated with the event.
|
void |
debug(Logger.EventType type,
String message)
Log a debug level security event if 'debug' level logging is enabled.
|
void |
debug(Logger.EventType type,
String message,
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,
String message)
Log an error level security event if 'error' level logging is enabled.
|
void |
error(Logger.EventType type,
String message,
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,
String message)
Log a fatal event if 'fatal' level logging is enabled.
|
void |
fatal(Logger.EventType type,
String message,
Throwable throwable)
Log a fatal level security event if 'fatal' level logging is enabled
and also record the stack trace associated with the event.
|
int |
getESAPILevel()
Retrieve the current ESAPI logging level for this logger.
|
void |
info(Logger.EventType type,
String message)
Log an info level security event if 'info' level logging is enabled.
|
void |
info(Logger.EventType type,
String message,
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 ESAPI logging severity level.
|
void |
trace(Logger.EventType type,
String message)
Log a trace level security event if 'trace' level logging is enabled.
|
void |
trace(Logger.EventType type,
String message,
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,
String message)
Log a warning level security event if 'warning' level logging is enabled.
|
void |
warning(Logger.EventType type,
String message,
Throwable throwable)
Log a warning level security event if 'warning' level logging is enabled
and also record the stack trace associated with the event.
|
static final Logger.EventType SECURITY_SUCCESS
static final Logger.EventType SECURITY_FAILURE
static final Logger.EventType SECURITY_AUDIT
static final Logger.EventType EVENT_SUCCESS
static final Logger.EventType EVENT_FAILURE
static final Logger.EventType EVENT_UNSPECIFIED
static final int OFF
static final int FATAL
static final int ERROR
static final int WARNING
static final int INFO
static final int DEBUG
static final int TRACE
static final int ALL
void setLevel(int level)
level
- The level to set the logging level to.int getESAPILevel()
Log4JLogger
for an explanation of
why this method is not simply called getLevel()
.void fatal(Logger.EventType type, String message)
type
- the type of eventmessage
- the message to logvoid fatal(Logger.EventType type, String message, Throwable throwable)
type
- the type of eventmessage
- the message to logthrowable
- the exception to be loggedboolean isFatalEnabled()
void error(Logger.EventType type, String message)
type
- the type of eventmessage
- the message to logvoid error(Logger.EventType type, String message, Throwable throwable)
type
- the type of eventmessage
- the message to logthrowable
- the exception to be loggedboolean isErrorEnabled()
void warning(Logger.EventType type, String message)
type
- the type of eventmessage
- the message to logvoid warning(Logger.EventType type, String message, Throwable throwable)
type
- the type of eventmessage
- the message to logthrowable
- the exception to be loggedboolean isWarningEnabled()
void info(Logger.EventType type, String message)
type
- the type of eventmessage
- the message to logvoid info(Logger.EventType type, String message, Throwable throwable)
type
- the type of eventmessage
- the message to logthrowable
- the exception to be loggedboolean isInfoEnabled()
void debug(Logger.EventType type, String message)
type
- the type of eventmessage
- the message to logvoid debug(Logger.EventType type, String message, Throwable throwable)
type
- the type of eventmessage
- the message to logthrowable
- the exception to be loggedboolean isDebugEnabled()
void trace(Logger.EventType type, String message)
type
- the type of eventmessage
- the message to logvoid trace(Logger.EventType type, String message, Throwable throwable)
type
- the type of eventmessage
- the message to logthrowable
- the exception to be loggedboolean isTraceEnabled()
void always(Logger.EventType type, String message)
type
- the type of eventmessage
- the message to logvoid always(Logger.EventType type, String message, Throwable throwable)
type
- the type of eventmessage
- the message to logthrowable
- the exception to be loggedCopyright © 2020 The Open Web Application Security Project (OWASP). All rights reserved.