public interface BasicFunctionalLogger extends BasicContextualLogger
The functional logging sections describe above are handled by a functional logger as "functional activities", which are intended to capture delimited portions of a logical flow.
Bellow is an example of how to log functional activities:
BasicFunctionalLogger logger = getMyFuntionalLogger();
logger.beginActivity(Level.INFO, "My main function");
try
{
// My main function flows here
}
finally
{
logger.endCurrentActivity();
}
It is very important that consumers do match calls to beginActivity with corresponding calls to endCurrentActivity in order to guarantee proper rendering in ODLA's tree view.
ADFLogger
Modifier and Type | Method and Description |
---|---|
void |
addContextData(java.util.logging.Level level,
java.util.Map<java.lang.String,java.lang.String> contextData)
This method will add the given context data map's content to the current
functional activity started by the latest call to beginActivity.
|
void |
addContextData(java.util.logging.Level level,
java.lang.String name,
java.lang.String value)
This method will add the given name/value pair as additional context data
to the current functional activity started by the latest call to beginActivity.
|
void |
addContextData(java.util.Map<java.lang.String,java.lang.String> contextData)
This method will add the given context data map's content to the current
functional activity started by the latest call to beginActivity.
|
void |
addContextData(java.lang.String name,
java.lang.String value)
This method will add the given name/value pair as additional context data
to the current functional activity started by the latest call to beginActivity.
|
void |
beginActivity(java.util.logging.Level level,
java.lang.String activity)
This method will start a new functional activity section in the log,
if and only if the the logger is currently set to publish messages at the
specified level.
|
void |
beginActivity(java.util.logging.Level level,
java.lang.String activity,
java.util.Map<java.lang.String,java.lang.String> contextData)
This method will start a new functional activity section in the log,
if and only if the the logger is currently set to publish messages at the
specified level.
|
void |
endCurrentActivity()
This method will mark the end of the current functional activity section in the log.
|
void |
endCurrentActivity(java.util.Map<java.lang.String,java.lang.String> contextData)
This method will mark the end of the current functional activity section in the log.
|
void |
endCurrentActivity(java.lang.Throwable error)
This method will mark the end of the current functional activity section in the log,
adding details of the given error as context data to the ending activity.
|
void |
endCurrentActivity(java.lang.Throwable error,
java.util.Map<java.lang.String,java.lang.String> contextData)
This method will mark the end of the current functional activity section in the log,
adding details of the given error plus the given context data map's content to the
ending functional activity.
|
java.lang.String |
getComponent()
Get the logging component name determined by the logger's domain
|
java.lang.String |
getCurrentActivity()
Retrieve the name of the current functional activity started by the
latest call to beginActivity, if any.
|
void |
log(java.util.logging.Level level,
java.lang.String message,
java.util.Map<java.lang.String,java.lang.String> contextData)
Log a message at the specified level, if and only if the logger is currently
set to publish messages at that level.
|
void |
log(java.util.logging.Level level,
java.lang.String message,
java.lang.Throwable error,
java.util.Map<java.lang.String,java.lang.String> contextData)
Log a message at the specified level, if and only if the logger is currently
set to publish messages at that level.
|
void |
log(java.util.logging.Level level,
java.lang.Throwable error,
java.util.Map<java.lang.String,java.lang.String> contextData)
Log a message at the specified level, based on the given error,
if and only if the logger is currently set to publish messages at that level.
|
close
getName, isLoggable, log, log, log
java.lang.String getComponent()
void addContextData(java.lang.String name, java.lang.String value)
name
- Name of the context data propertyvalue
- Value of the context data propertyvoid addContextData(java.util.Map<java.lang.String,java.lang.String> contextData)
contextData
- Map with context data properties to add to
the current functional activityvoid addContextData(java.util.logging.Level level, java.lang.String name, java.lang.String value)
level
- Logging level at which the method will be effectivename
- Name of the context data propertyvalue
- Value of the context data propertyvoid addContextData(java.util.logging.Level level, java.util.Map<java.lang.String,java.lang.String> contextData)
level
- Logging level at which the method will be effectivecontextData
- Map with context data properties to add to
the current functional activityvoid log(java.util.logging.Level level, java.lang.String message, java.util.Map<java.lang.String,java.lang.String> contextData)
level
- The level which the message should be logged atmessage
- The message to be loggedcontextData
- Optional map with context data properties to add to
the current functional activityvoid log(java.util.logging.Level level, java.lang.String message, java.lang.Throwable error, java.util.Map<java.lang.String,java.lang.String> contextData)
level
- The level which the message should be logged atmessage
- The message to be loggederror
- Error which to include relevant details from. It is up to
each implementation to decide which details are relevant.contextData
- Optional map with context data properties to add to
the current functional activityvoid log(java.util.logging.Level level, java.lang.Throwable error, java.util.Map<java.lang.String,java.lang.String> contextData)
level
- The level which the message should be logged aterror
- Error which to derive the log message and also include relevant
details from. It is up to each implementation to decide the log message and
which details are relevant to include.contextData
- Optional map with context data properties to add to
the current functional activityvoid beginActivity(java.util.logging.Level level, java.lang.String activity)
level
- Logging level at which the method will be effectiveactivity
- The functional activity's namevoid beginActivity(java.util.logging.Level level, java.lang.String activity, java.util.Map<java.lang.String,java.lang.String> contextData)
level
- Logging level at which the method will be effectiveactivity
- The functional activity's namecontextData
- Optional map with context data properties to add to
the new functional activityvoid endCurrentActivity()
void endCurrentActivity(java.util.Map<java.lang.String,java.lang.String> contextData)
contextData
- Optional map with context data properties to add to
the current functional activityvoid endCurrentActivity(java.lang.Throwable error)
error
- Error which to include relevant
details from. It is up to each implementation to decide which details are relevant.void endCurrentActivity(java.lang.Throwable error, java.util.Map<java.lang.String,java.lang.String> contextData)
error
- Error which to include relevant
details from. It is up to each implementation to decide which details are relevant.contextData
- Optional map with context data properties to add to
the current functional activityjava.lang.String getCurrentActivity()