Class StatusLoggerAdmin
- java.lang.Object
-
- javax.management.NotificationBroadcasterSupport
-
- org.apache.logging.log4j.core.jmx.StatusLoggerAdmin
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,EventListener
,NotificationBroadcaster
,NotificationEmitter
,StatusLoggerAdminMBean
,StatusListener
public class StatusLoggerAdmin extends NotificationBroadcasterSupport implements StatusListener, StatusLoggerAdminMBean
Implementation of theStatusLoggerAdminMBean
interface.
-
-
Field Summary
-
Fields inherited from interface org.apache.logging.log4j.core.jmx.StatusLoggerAdminMBean
NOTIF_TYPE_DATA, NOTIF_TYPE_MESSAGE, PATTERN
-
-
Constructor Summary
Constructors Constructor Description StatusLoggerAdmin(String contextName, Executor executor)
Constructs a newStatusLoggerAdmin
with theExecutor
to be used for sendingNotification
s asynchronously to listeners.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
String
getContextName()
Returns the name of the LoggerContext that theStatusLogger
is associated with.String
getLevel()
Returns theStatusLogger
level as a String.ObjectName
getObjectName()
Returns theObjectName
of this mbean.List<StatusData>
getStatusData()
Returns a list with the most recentStatusData
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 theStatusLogger
level to the specified value.-
Methods inherited from class javax.management.NotificationBroadcasterSupport
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
-
-
-
-
Constructor Detail
-
StatusLoggerAdmin
public StatusLoggerAdmin(String contextName, Executor executor)
Constructs a newStatusLoggerAdmin
with theExecutor
to be used for sendingNotification
s asynchronously to listeners.- Parameters:
contextName
- name of the LoggerContext under which to register this StatusLoggerAdmin. Note that the StatusLogger may be registered multiple times, once for each LoggerContext. In web containers, each web application has its own LoggerContext and by associating the StatusLogger with the LoggerContext, all associated MBeans can be unloaded when the web application is undeployed.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 interfaceStatusLoggerAdminMBean
- 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 recentStatusData
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
Throwable
s 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
Throwable
s in their classpath.- Specified by:
getStatusData
in interfaceStatusLoggerAdminMBean
- Returns:
- the most recent messages logged by the
StatusLogger
.
-
getLevel
public String getLevel()
Description copied from interface:StatusLoggerAdminMBean
Returns theStatusLogger
level as a String.- Specified by:
getLevel
in interfaceStatusLoggerAdminMBean
- 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 interfaceStatusListener
- Returns:
- the Log Level.
-
setLevel
public void setLevel(String level)
Description copied from interface:StatusLoggerAdminMBean
Sets theStatusLogger
level to the specified value.- Specified by:
setLevel
in interfaceStatusLoggerAdminMBean
- Parameters:
level
- the newStatusLogger
level.
-
getContextName
public String getContextName()
Description copied from interface:StatusLoggerAdminMBean
Returns the name of the LoggerContext that theStatusLogger
is associated with.- Specified by:
getContextName
in interfaceStatusLoggerAdminMBean
- Returns:
- logger context name
-
log
public void log(StatusData data)
Description copied from interface:StatusListener
Called as events occur to process the StatusData.- Specified by:
log
in interfaceStatusListener
- Parameters:
data
- The StatusData for the event.
-
getObjectName
public ObjectName getObjectName()
Returns theObjectName
of this mbean.- Specified by:
getObjectName
in interfaceStatusLoggerAdminMBean
- Returns:
- the
ObjectName
- See Also:
StatusLoggerAdminMBean.PATTERN
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
-