org.apache.logging.log4j.core.jmx

Class StatusLoggerAdmin

java.lang.Object

javax.management.NotificationBroadcasterSupport

org.apache.logging.log4j.core.jmx.StatusLoggerAdmin

All Implemented Interfaces:

NotificationBroadcaster, NotificationEmitter, StatusLoggerAdminMBean, StatusListener

public class StatusLoggerAdmin
extends NotificationBroadcasterSupport
implements StatusListener, StatusLoggerAdminMBean

Implementation of the StatusLoggerAdminMBean interface.

Field Summary

Fields inherited from interface org.apache.logging.log4j.core.jmx.StatusLoggerAdminMBean

NAME, NOTIF_TYPE_DATA, NOTIF_TYPE_MESSAGE

Constructor Summary

Constructors

Constructor and Description
StatusLoggerAdmin(Executor executor) Constructs a new StatusLoggerAdmin with the Executor to be used for sending Notifications asynchronously to listeners.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLevel() Returns the StatusLogger level as a String.
ObjectName	getObjectName() Returns the ObjectName of this mbean.
List<StatusData>	getStatusData() Returns a list with the most recent StatusData objects in the status history.
String[]	getStatusDataHistory() Returns a string array with the most recent messages in the status history.
Level	getStatusLevel() Return the Log Level that this listener wants included.
void	log(StatusData data) Called as events occur to process the StatusData.
void	setLevel(String level) Sets the StatusLogger level to the specified value.

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusLoggerAdmin

public StatusLoggerAdmin(Executor executor)

Constructs a new StatusLoggerAdmin with the Executor to be used for sending Notifications asynchronously to listeners.

Parameters:

executor - used to send notifications asynchronously

Method Detail

getStatusDataHistory

public String[] getStatusDataHistory()

Description copied from interface: StatusLoggerAdminMBean

Returns a string array with the most recent messages in the status history. The list has up to 200 entries by default but the length can be configured with system property "log4j2.status.entries".

Specified by:

getStatusDataHistory in interface StatusLoggerAdminMBean

Returns:

the most recent messages logged by the StatusLogger.

getStatusData

public List<StatusData> getStatusData()

Description copied from interface: StatusLoggerAdminMBean

Returns a list with the most recent StatusData objects in the status history. The list has up to 200 entries by default but the length can be configured with system property "log4j2.status.entries".

Note that the returned objects may contain Throwables from external libraries. JMX clients calling this method must be prepared to deal with the errors that occur if they do not have the class definition for such Throwables in their classpath.

Specified by:

getStatusData in interface StatusLoggerAdminMBean

Returns:

the most recent messages logged by the StatusLogger.

getLevel

public String getLevel()

Description copied from interface: StatusLoggerAdminMBean

Returns the StatusLogger level as a String.

Specified by:

getLevel in interface StatusLoggerAdminMBean

Returns:

the StatusLogger level.

getStatusLevel

public Level getStatusLevel()

Description copied from interface: StatusListener

Return the Log Level that this listener wants included.

Specified by:

getStatusLevel in interface StatusListener

Returns:

the Log Level.

setLevel

public void setLevel(String level)

Description copied from interface: StatusLoggerAdminMBean

Sets the StatusLogger level to the specified value.

Specified by:

setLevel in interface StatusLoggerAdminMBean

Parameters:

level - the new StatusLogger level.

log

public void log(StatusData data)

Description copied from interface: StatusListener

Called as events occur to process the StatusData.

Specified by:

log in interface StatusListener

Parameters:

data - The StatusData for the event.

getObjectName

public ObjectName getObjectName()

Returns the ObjectName of this mbean.

Returns:

the ObjectName

See Also:

StatusLoggerAdminMBean.NAME