public class StatusLoggerAdmin extends NotificationBroadcasterSupport implements StatusListener, StatusLoggerAdminMBean
StatusLoggerAdminMBean interface.NOTIF_TYPE_DATA, NOTIF_TYPE_MESSAGE, PATTERN| Constructor and Description |
|---|
StatusLoggerAdmin(String contextName,
Executor executor)
Constructs a new
StatusLoggerAdmin with the Executor to
be used for sending Notifications asynchronously to listeners. |
| Modifier and Type | Method and Description |
|---|---|
void |
close() |
String |
getContextName()
Returns the name of the LoggerContext that the
StatusLogger is associated with. |
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() |
void |
log(StatusData data) |
void |
setLevel(String level)
Sets the
StatusLogger level to the specified value. |
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotificationpublic StatusLoggerAdmin(String contextName, Executor executor)
StatusLoggerAdmin with the Executor to
be used for sending Notifications asynchronously to listeners.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 asynchronouslypublic String[] getStatusDataHistory()
StatusLoggerAdminMBean"log4j2.status.entries".getStatusDataHistory in interface StatusLoggerAdminMBeanStatusLogger.public List<StatusData> getStatusData()
StatusLoggerAdminMBeanStatusData 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.
getStatusData in interface StatusLoggerAdminMBeanStatusLogger.public String getLevel()
StatusLoggerAdminMBeanStatusLogger level as a String.getLevel in interface StatusLoggerAdminMBeanStatusLogger level.public Level getStatusLevel()
getStatusLevel in interface StatusListenerpublic void setLevel(String level)
StatusLoggerAdminMBeanStatusLogger level to the specified value.setLevel in interface StatusLoggerAdminMBeanlevel - the new StatusLogger level.public String getContextName()
StatusLoggerAdminMBeanStatusLogger is associated with.getContextName in interface StatusLoggerAdminMBeanpublic void log(StatusData data)
log in interface StatusListenerpublic ObjectName getObjectName()
ObjectName of this mbean.getObjectName in interface StatusLoggerAdminMBeanObjectNameStatusLoggerAdminMBean.PATTERNpublic void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableIOExceptionCopyright © 1999-2021 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.