org.weborganic.bastille.log
Interface LogInfo

All Known Implementing Classes:

LogbackInfo

public interface LogInfo

A interface centralizing all common functionalities for the log implementations.

Since:

Bastille 0.8.5

Method Summary

LogLevel	getRecentEventThreshold() Returns the threshold for the recent logs.
void	init() Performs any necessary initialisation.
List<File>	listLogDirectories() Returns a list of directories where log files are being stored.
List<? extends XMLWritable>	listRecentEvents() Returns a list of the recent log entries as XMLWritable.
void	setRecentEventThreshold(LogLevel level) Set the threshold for the recent logs.
boolean	supportsListLogDirectories() Indicates whether the logging framework supports the listing of log directories.
boolean	supportsRecentEvents() Indicates whether the logging framework supports the recent log functionality.

Method Detail

init

void init()

Performs any necessary initialisation.

supportsListLogDirectories

boolean supportsListLogDirectories()

Indicates whether the logging framework supports the listing of log directories.

Returns:

true if recent logs are supported; false otherwise.

listLogDirectories

List<File> listLogDirectories()

Returns a list of directories where log files are being stored.

Implementations must return an empty list rather than null.

Returns:

Always a list (never null)

supportsRecentEvents

boolean supportsRecentEvents()

Indicates whether the logging framework supports the recent log functionality.

Returns:

true if recent logs are supported; false otherwise.

setRecentEventThreshold

void setRecentEventThreshold(LogLevel level)

Set the threshold for the recent logs.

Parameters:

level - The threshold for keeping recent log events including that level.

getRecentEventThreshold

LogLevel getRecentEventThreshold()

Returns the threshold for the recent logs.

Returns:

The threshold for keeping recent log events including that level.

listRecentEvents

List<? extends XMLWritable> listRecentEvents()

Returns a list of the recent log entries as XMLWritable.

Implementations must return an empty list rather than null.

Returns:

Always a list (never null)