| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StatusLoggerAdmin (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.jmx, class: StatusLoggerAdmin"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/StatusLoggerAdmin.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.jmx</a></div> |
| <h1 title="Class StatusLoggerAdmin" class="title">Class StatusLoggerAdmin</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html" title="class or interface in javax.management" class="external-link">javax.management.NotificationBroadcasterSupport</a> |
| <div class="inheritance">org.apache.logging.log4j.core.jmx.StatusLoggerAdmin</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html" title="class or interface in javax.management" class="external-link">MBeanRegistration</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcaster.html" title="class or interface in javax.management" class="external-link">NotificationBroadcaster</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationEmitter.html" title="class or interface in javax.management" class="external-link">NotificationEmitter</a></code>, <code><a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusListener.html" title="class or interface in org.apache.logging.log4j.status" class="external-link">StatusListener</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">StatusLoggerAdmin</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html" title="class or interface in javax.management" class="external-link">NotificationBroadcasterSupport</a> |
| implements <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusListener.html" title="class or interface in org.apache.logging.log4j.status" class="external-link">StatusListener</a>, <a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html" title="class or interface in javax.management" class="external-link">MBeanRegistration</a></span></div> |
| <div class="block">Implementation of the <code>StatusLoggerAdminMBean</code> interface.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.jmx.StatusLoggerAdminMBean">Fields inherited from interface org.apache.logging.log4j.core.jmx.<a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a></h3> |
| <code><a href="StatusLoggerAdminMBean.html#NOTIF_TYPE_DATA">NOTIF_TYPE_DATA</a>, <a href="StatusLoggerAdminMBean.html#NOTIF_TYPE_MESSAGE">NOTIF_TYPE_MESSAGE</a>, <a href="StatusLoggerAdminMBean.html#PATTERN">PATTERN</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.util.concurrent.Executor)" class="member-name-link">StatusLoggerAdmin</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> contextName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a> executor)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a new <code>StatusLoggerAdmin</code> with the <code>Executor</code> to |
| be used for sending <code>Notification</code>s asynchronously to listeners.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addNotificationListener(javax.management.NotificationListener,javax.management.NotificationFilter,java.lang.Object)" class="member-name-link">addNotificationListener</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationListener.html" title="class or interface in javax.management" class="external-link">NotificationListener</a> listener, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationFilter.html" title="class or interface in javax.management" class="external-link">NotificationFilter</a> filter, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> handback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContextName()" class="member-name-link">getContextName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name of the LoggerContext that the <code>StatusLogger</code> is associated with.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLevel()" class="member-name-link">getLevel</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the <code>StatusLogger</code> level as a String.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html" title="class or interface in javax.management" class="external-link">ObjectName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObjectName()" class="member-name-link">getObjectName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the <code>ObjectName</code> of this mbean.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusData.html" title="class or interface in org.apache.logging.log4j.status" class="external-link">StatusData</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStatusData()" class="member-name-link">getStatusData</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a list with the most recent <code>StatusData</code> objects in the |
| status history.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStatusDataHistory()" class="member-name-link">getStatusDataHistory</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a string array with the most recent messages in the status |
| history.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStatusLevel()" class="member-name-link">getStatusLevel</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#log(org.apache.logging.log4j.status.StatusData)" class="member-name-link">log</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusData.html" title="class or interface in org.apache.logging.log4j.status" class="external-link">StatusData</a> data)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#postDeregister()" class="member-name-link">postDeregister</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#postRegister(java.lang.Boolean)" class="member-name-link">postRegister</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> registrationDone)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#preDeregister()" class="member-name-link">preDeregister</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html" title="class or interface in javax.management" class="external-link">ObjectName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#preRegister(javax.management.MBeanServer,javax.management.ObjectName)" class="member-name-link">preRegister</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html" title="class or interface in javax.management" class="external-link">MBeanServer</a> server, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html" title="class or interface in javax.management" class="external-link">ObjectName</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLevel(java.lang.String)" class="member-name-link">setLevel</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> level)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the <code>StatusLogger</code> level to the specified value.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-javax.management.NotificationBroadcasterSupport">Methods inherited from class javax.management.<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html" title="class or interface in javax.management" class="external-link">NotificationBroadcasterSupport</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html#getNotificationInfo--" title="class or interface in javax.management" class="external-link">getNotificationInfo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html#handleNotification-javax.management.NotificationListener-javax.management.Notification-java.lang.Object-" title="class or interface in javax.management" class="external-link">handleNotification</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html#removeNotificationListener-javax.management.NotificationListener-" title="class or interface in javax.management" class="external-link">removeNotificationListener</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html#removeNotificationListener-javax.management.NotificationListener-javax.management.NotificationFilter-java.lang.Object-" title="class or interface in javax.management" class="external-link">removeNotificationListener</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html#sendNotification-javax.management.Notification-" title="class or interface in javax.management" class="external-link">sendNotification</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.util.concurrent.Executor)"> |
| <h3>StatusLoggerAdmin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StatusLoggerAdmin</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> contextName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a> executor)</span></div> |
| <div class="block">Constructs a new <code>StatusLoggerAdmin</code> with the <code>Executor</code> to |
| be used for sending <code>Notification</code>s asynchronously to listeners.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>contextName</code> - 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.</dd> |
| <dd><code>executor</code> - used to send notifications asynchronously</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="addNotificationListener(javax.management.NotificationListener,javax.management.NotificationFilter,java.lang.Object)"> |
| <h3>addNotificationListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addNotificationListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationListener.html" title="class or interface in javax.management" class="external-link">NotificationListener</a> listener, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationFilter.html" title="class or interface in javax.management" class="external-link">NotificationFilter</a> filter, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> handback)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcaster.html#addNotificationListener-javax.management.NotificationListener-javax.management.NotificationFilter-java.lang.Object-" title="class or interface in javax.management" class="external-link">addNotificationListener</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcaster.html" title="class or interface in javax.management" class="external-link">NotificationBroadcaster</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html#addNotificationListener-javax.management.NotificationListener-javax.management.NotificationFilter-java.lang.Object-" title="class or interface in javax.management" class="external-link">addNotificationListener</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html" title="class or interface in javax.management" class="external-link">NotificationBroadcasterSupport</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="preRegister(javax.management.MBeanServer,javax.management.ObjectName)"> |
| <h3>preRegister</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html" title="class or interface in javax.management" class="external-link">ObjectName</a></span> <span class="element-name">preRegister</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html" title="class or interface in javax.management" class="external-link">MBeanServer</a> server, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html" title="class or interface in javax.management" class="external-link">ObjectName</a> name)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html#preRegister-javax.management.MBeanServer-javax.management.ObjectName-" title="class or interface in javax.management" class="external-link">preRegister</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html" title="class or interface in javax.management" class="external-link">MBeanRegistration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="postRegister(java.lang.Boolean)"> |
| <h3>postRegister</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">postRegister</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> registrationDone)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html#postRegister-java.lang.Boolean-" title="class or interface in javax.management" class="external-link">postRegister</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html" title="class or interface in javax.management" class="external-link">MBeanRegistration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="preDeregister()"> |
| <h3>preDeregister</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">preDeregister</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html#preDeregister--" title="class or interface in javax.management" class="external-link">preDeregister</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html" title="class or interface in javax.management" class="external-link">MBeanRegistration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="postDeregister()"> |
| <h3>postDeregister</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">postDeregister</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html#postDeregister--" title="class or interface in javax.management" class="external-link">postDeregister</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanRegistration.html" title="class or interface in javax.management" class="external-link">MBeanRegistration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStatusDataHistory()"> |
| <h3>getStatusDataHistory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">getStatusDataHistory</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="StatusLoggerAdminMBean.html#getStatusDataHistory()">StatusLoggerAdminMBean</a></code></span></div> |
| <div class="block">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 <code>"log4j2.status.entries"</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="StatusLoggerAdminMBean.html#getStatusDataHistory()">getStatusDataHistory</a></code> in interface <code><a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the most recent messages logged by the <code>StatusLogger</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStatusData()"> |
| <h3>getStatusData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusData.html" title="class or interface in org.apache.logging.log4j.status" class="external-link">StatusData</a>></span> <span class="element-name">getStatusData</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="StatusLoggerAdminMBean.html#getStatusData()">StatusLoggerAdminMBean</a></code></span></div> |
| <div class="block">Returns a list with the most recent <code>StatusData</code> objects in the |
| status history. The list has up to 200 entries by default but the length |
| can be configured with system property <code>"log4j2.status.entries"</code>. |
| <p> |
| Note that the returned objects may contain <code>Throwable</code>s from |
| external libraries. |
| </p> |
| <p> |
| 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 |
| <code>Throwable</code>s in their classpath. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="StatusLoggerAdminMBean.html#getStatusData()">getStatusData</a></code> in interface <code><a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the most recent messages logged by the <code>StatusLogger</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLevel()"> |
| <h3>getLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getLevel</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="StatusLoggerAdminMBean.html#getLevel()">StatusLoggerAdminMBean</a></code></span></div> |
| <div class="block">Returns the <code>StatusLogger</code> level as a String.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="StatusLoggerAdminMBean.html#getLevel()">getLevel</a></code> in interface <code><a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <code>StatusLogger</code> level.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStatusLevel()"> |
| <h3>getStatusLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a></span> <span class="element-name">getStatusLevel</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusListener.html#getStatusLevel()" title="class or interface in org.apache.logging.log4j.status" class="external-link">getStatusLevel</a></code> in interface <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusListener.html" title="class or interface in org.apache.logging.log4j.status" class="external-link">StatusListener</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLevel(java.lang.String)"> |
| <h3>setLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLevel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> level)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="StatusLoggerAdminMBean.html#setLevel(java.lang.String)">StatusLoggerAdminMBean</a></code></span></div> |
| <div class="block">Sets the <code>StatusLogger</code> level to the specified value.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="StatusLoggerAdminMBean.html#setLevel(java.lang.String)">setLevel</a></code> in interface <code><a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - the new <code>StatusLogger</code> level.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContextName()"> |
| <h3>getContextName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getContextName</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="StatusLoggerAdminMBean.html#getContextName()">StatusLoggerAdminMBean</a></code></span></div> |
| <div class="block">Returns the name of the LoggerContext that the <code>StatusLogger</code> is associated with.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="StatusLoggerAdminMBean.html#getContextName()">getContextName</a></code> in interface <code><a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>logger context name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="log(org.apache.logging.log4j.status.StatusData)"> |
| <h3>log</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">log</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusData.html" title="class or interface in org.apache.logging.log4j.status" class="external-link">StatusData</a> data)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusListener.html#log(org.apache.logging.log4j.status.StatusData)" title="class or interface in org.apache.logging.log4j.status" class="external-link">log</a></code> in interface <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusListener.html" title="class or interface in org.apache.logging.log4j.status" class="external-link">StatusListener</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjectName()"> |
| <h3>getObjectName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html" title="class or interface in javax.management" class="external-link">ObjectName</a></span> <span class="element-name">getObjectName</span>()</div> |
| <div class="block">Returns the <code>ObjectName</code> of this mbean.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="StatusLoggerAdminMBean.html#getObjectName()">getObjectName</a></code> in interface <code><a href="StatusLoggerAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">StatusLoggerAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <code>ObjectName</code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="StatusLoggerAdminMBean.html#PATTERN"><code>StatusLoggerAdminMBean.PATTERN</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html#close--" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html#close--" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> 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. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
