org.apache.logging.log4j.status
Class StatusLogger

java.lang.Object
  org.apache.logging.log4j.spi.AbstractLogger
      org.apache.logging.log4j.status.StatusLogger

All Implemented Interfaces:

Logger

public final class StatusLogger
extends AbstractLogger

Mechanism to record events that occur in the logging system.

Field Summary

static String

MAX_STATUS_ENTRIES System property that can be configured with the number of entries in the queue.

Fields inherited from class org.apache.logging.log4j.spi.AbstractLogger

CATCHING_MARKER, DEFAULT_MESSAGE_FACTORY_CLASS, ENTRY_MARKER, EXCEPTION_MARKER, EXIT_MARKER, FLOW_MARKER, THROWING_MARKER

Method Summary

void	clear() Clears the list of status events.
Level	getLevel()
Iterator<StatusListener>	getListeners() Returns a thread safe Iterator for the StatusListener.
static StatusLogger	getLogger() Retrieve the StatusLogger.
List<StatusData>	getStatusData() Returns a List of all events as StatusData objects.
boolean	isEnabled(Level level, Marker marker) Checks whether this logger is enabled at the specified level and an optional Marker.
protected boolean	isEnabled(Level level, Marker marker, Message data, Throwable t) Determine if logging is enabled.
protected boolean	isEnabled(Level level, Marker marker, Object data, Throwable t) Determine if logging is enabled.
protected boolean	isEnabled(Level level, Marker marker, String data) Determine if logging is enabled.
protected boolean	isEnabled(Level level, Marker marker, String data, Object... p1) Determine if logging is enabled.
protected boolean	isEnabled(Level level, Marker marker, String data, Throwable t) Determine if logging is enabled.
void	log(Marker marker, String fqcn, Level level, Message msg, Throwable t) Add an event.
void	registerListener(StatusListener listener) Register a new listener.
void	removeListener(StatusListener listener) Remove a StatusListener.
void	reset() Clears the list of status events and listeners.
void	setLevel(Level level)

Methods inherited from class org.apache.logging.log4j.spi.AbstractLogger

catching, catching, catching, checkMessageFactory, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, entry, entry, entry, error, error, error, error, error, error, error, error, error, error, error, error, error, error, exit, exit, exit, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, getMessageFactory, getName, info, info, info, info, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isEnabled, isErrorEnabled, isErrorEnabled, isFatalEnabled, isFatalEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, log, log, log, log, log, log, log, log, log, log, log, log, log, log, throwing, throwing, throwing, toString, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_STATUS_ENTRIES

public static final String MAX_STATUS_ENTRIES

System property that can be configured with the number of entries in the queue. Once the limit is reached older entries will be removed as new entries are added.

See Also:

Constant Field Values

Method Detail

getLogger

public static StatusLogger getLogger()

Retrieve the StatusLogger.

Returns:

The StatusLogger.

getLevel

public Level getLevel()

setLevel

public void setLevel(Level level)

registerListener

public void registerListener(StatusListener listener)

Register a new listener.

Parameters:

listener - The StatusListener to register.

removeListener

public void removeListener(StatusListener listener)

Remove a StatusListener.

Parameters:

listener - The StatusListener to remove.

getListeners

public Iterator<StatusListener> getListeners()

Returns a thread safe Iterator for the StatusListener.

Returns:

An Iterator for the list of StatusListeners.

reset

public void reset()

Clears the list of status events and listeners.

getStatusData

public List<StatusData> getStatusData()

Returns a List of all events as StatusData objects.

Returns:

The list of StatusData objects.

clear

public void clear()

Clears the list of status events.

log

public void log(Marker marker,
                String fqcn,
                Level level,
                Message msg,
                Throwable t)

Add an event.

Specified by:

log in class AbstractLogger

Parameters:

marker - The Marker

fqcn - The fully qualified class name of the caller

level - The logging level

msg - The message associated with the event.

t - A Throwable or null.

isEnabled

protected boolean isEnabled(Level level,
                            Marker marker,
                            String data)

Description copied from class: AbstractLogger

Determine if logging is enabled.

Specified by:

isEnabled in class AbstractLogger

Parameters:

level - The logging Level to check.

marker - A Marker or null.

data - The message.

Returns:

True if logging is enabled, false otherwise.

isEnabled

protected boolean isEnabled(Level level,
                            Marker marker,
                            String data,
                            Throwable t)

Description copied from class: AbstractLogger

Determine if logging is enabled.

Specified by:

isEnabled in class AbstractLogger

Parameters:

level - The logging Level to check.

marker - A Marker or null.

data - The message.

t - A Throwable.

Returns:

True if logging is enabled, false otherwise.

isEnabled

protected boolean isEnabled(Level level,
                            Marker marker,
                            String data,
                            Object... p1)

Description copied from class: AbstractLogger

Determine if logging is enabled.

Specified by:

isEnabled in class AbstractLogger

Parameters:

level - The logging Level to check.

marker - A Marker or null.

data - The message.

p1 - The parameters.

Returns:

True if logging is enabled, false otherwise.

isEnabled

protected boolean isEnabled(Level level,
                            Marker marker,
                            Object data,
                            Throwable t)

Description copied from class: AbstractLogger

Determine if logging is enabled.

Specified by:

isEnabled in class AbstractLogger

Parameters:

level - The logging Level to check.

marker - A Marker or null.

data - The message.

t - A Throwable.

Returns:

True if logging is enabled, false otherwise.

isEnabled

protected boolean isEnabled(Level level,
                            Marker marker,
                            Message data,
                            Throwable t)

Description copied from class: AbstractLogger

Determine if logging is enabled.

Specified by:

isEnabled in class AbstractLogger

Parameters:

level - The logging Level to check.

marker - A Marker or null.

data - The Message.

t - A Throwable.

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level level,
                         Marker marker)

Description copied from interface: Logger

Checks whether this logger is enabled at the specified level and an optional Marker.

Specified by:

isEnabled in interface Logger

Overrides:

isEnabled in class AbstractLogger

Parameters:

level - The Level to check.

marker - The marker data specific to this log statement.

Returns:

boolean - true if this Logger is enabled for level WARN, false otherwise.