org.jboss.logging

Interface LoggerPluginInstance

All Known Implementing Classes:

AbstractLoggerPluginInstance, NullLoggerPluginInstance

public interface LoggerPluginInstance

Defines a "pluggable" login module's logger implementation.

Version:

$Revision: 3403 $

Author:

Sacha Labourey, David M. Lloyd

See Also:

Logger, NullLoggerPluginInstance

Method Summary

Methods

Modifier and Type	Method and Description
Logger	getLogger() Get the logger API instance associated with this plugin instance.
LoggerPlugin	getLoggerPlugin()
boolean	isEnabled(Logger.Level level) Determine whether logging is enabled for the given level.
void	log(Logger.Level level, String loggerFqcn, Object message, Object[] params, Throwable t) Log a message at the given level using messageformat formatting.
void	logf(Logger.Level level, String loggerFqcn, String format, Object[] params, Throwable t) Log a message at the given level using printf formatting.

Method Detail

getLoggerPlugin

LoggerPlugin getLoggerPlugin()

getLogger

Logger getLogger()

Get the logger API instance associated with this plugin instance.

Returns:

the logger instance

isEnabled

boolean isEnabled(Logger.Level level)

Determine whether logging is enabled for the given level.

Parameters:

level - the level

Returns:

false if logging is disabled, or true if logging is enabled or cannot be ascertained

log

void log(Logger.Level level,
       String loggerFqcn,
       Object message,
       Object[] params,
       Throwable t)

Log a message at the given level using messageformat formatting.

Parameters:

level - the level

loggerFqcn - the fully qualified class name

message - the message

params - the message parameters or null if none

t - the throwable cause or null if none

logf

void logf(Logger.Level level,
        String loggerFqcn,
        String format,
        Object[] params,
        Throwable t)

Log a message at the given level using printf formatting.

Parameters:

level - the level

loggerFqcn - the fully qualified class name

format - the message format

params - the message parameters or null if none

t - the throwable cause or null if none