StatusLogger (Log4J API 2.0-beta1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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, ENTRY_MARKER, EXCEPTION_MARKER, EXIT_MARKER, FLOW_MARKER, THROWING_MARKER`

Method Summary
`void`	`clear()` Clears the list of status events.
`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.
`protected boolean`	`isEnabled(Level level, Marker 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, Object p1, Object p2)` Determine if logging is enabled.
`protected boolean`	`isEnabled(Level level, Marker marker, String data, Object p1, Object p2, Object p3)` Determine if logging is enabled.
`protected boolean`	`isEnabled(Level level, Marker marker, String data, Object p1, Object p2, Object p3, Object... params)` 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.

Methods inherited from class org.apache.logging.log4j.spi.AbstractLogger
catching, catching, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, entry, entry, error, error, error, error, error, error, error, error, error, error, error, error, error, error, exit, exit, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, info, info, info, info, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isErrorEnabled, isErrorEnabled, isFatalEnabled, isFatalEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, throwing, throwing, 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 org.apache.logging.log4j.spi.AbstractLogger

catching, catching, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, entry, entry, error, error, error, error, error, error, error, error, error, error, error, error, error, error, exit, exit, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, info, info, info, info, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isErrorEnabled, isErrorEnabled, isFatalEnabled, isFatalEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, throwing, throwing, 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, toString, 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.

registerListener

public void registerListener(StatusListener 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.