blob: b525a95149c66d735186f3f5105e4dd20cf7acd8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sat Apr 25 12:11:41 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StatusLoggerAdminMBean (Apache Log4j Core 2.13.2 API)</title>
<meta name="date" content="2020-04-25">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StatusLoggerAdminMBean (Apache Log4j Core 2.13.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StatusLoggerAdminMBean.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdmin.html" title="class in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html" target="_top">Frames</a></li>
<li><a href="StatusLoggerAdminMBean.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.logging.log4j.core.jmx</div>
<h2 title="Interface StatusLoggerAdminMBean" class="title">Interface StatusLoggerAdminMBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdmin.html" title="class in org.apache.logging.log4j.core.jmx">StatusLoggerAdmin</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.28">StatusLoggerAdminMBean</a></pre>
<div class="block">The MBean interface for monitoring and managing the <code>StatusLogger</code>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#NOTIF_TYPE_DATA">NOTIF_TYPE_DATA</a></span></code>
<div class="block">Notifications with this type have a <code>StatusData</code> userData object
and a <code>null</code> message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#NOTIF_TYPE_MESSAGE">NOTIF_TYPE_MESSAGE</a></span></code>
<div class="block">Notifications with this type have a formatted status data message string
but no <code>StatusData</code> in their userData field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#PATTERN">PATTERN</a></span></code>
<div class="block">ObjectName pattern ("org.apache.logging.log4j2:type=%s,component=StatusLogger") for StatusLoggerAdmin MBeans.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#getContextName--">getContextName</a></span>()</code>
<div class="block">Returns the name of the LoggerContext that the <code>StatusLogger</code> is associated with.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#getLevel--">getLevel</a></span>()</code>
<div class="block">Returns the <code>StatusLogger</code> level as a String.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#getObjectName--">getObjectName</a></span>()</code>
<div class="block">Returns the <code>ObjectName</code> that this status logger mbean is registered with.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.logging.log4j.status.StatusData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#getStatusData--">getStatusData</a></span>()</code>
<div class="block">Returns a list with the most recent <code>StatusData</code> objects in the
status history.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#getStatusDataHistory--">getStatusDataHistory</a></span>()</code>
<div class="block">Returns a string array with the most recent messages in the status
history.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#setLevel-java.lang.String-">setLevel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;level)</code>
<div class="block">Sets the <code>StatusLogger</code> level to the specified value.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="PATTERN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PATTERN</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.52">PATTERN</a></pre>
<div class="block">ObjectName pattern ("org.apache.logging.log4j2:type=%s,component=StatusLogger") for StatusLoggerAdmin MBeans.
This pattern contains a variable, which is the name of the logger context.
<p>
You can find all registered StatusLoggerAdmin MBeans like this:
</p>
<pre>
MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
String pattern = String.format(StatusLoggerAdminMBean.PATTERN, &quot;*&quot;);
Set&lt;ObjectName&gt; statusLoggerNames = mbs.queryNames(new ObjectName(pattern), null);
</pre>
<p>
Some characters are not allowed in ObjectNames. The logger context name
may be quoted. When StatusLoggerAdmin MBeans are
registered, their ObjectNames are created using this pattern as follows:
</p>
<pre>
String ctxName = Server.escape(loggerContext.getName());
String name = String.format(PATTERN, ctxName);
ObjectName objectName = new ObjectName(name);
</pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/jmx/Server.html#escape-java.lang.String-"><code>Server.escape(String)</code></a>,
<a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.jmx.StatusLoggerAdminMBean.PATTERN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="NOTIF_TYPE_DATA">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NOTIF_TYPE_DATA</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.58">NOTIF_TYPE_DATA</a></pre>
<div class="block">Notifications with this type have a <code>StatusData</code> userData object
and a <code>null</code> message.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.jmx.StatusLoggerAdminMBean.NOTIF_TYPE_DATA">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="NOTIF_TYPE_MESSAGE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NOTIF_TYPE_MESSAGE</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.64">NOTIF_TYPE_MESSAGE</a></pre>
<div class="block">Notifications with this type have a formatted status data message string
but no <code>StatusData</code> in their userData field.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.jmx.StatusLoggerAdminMBean.NOTIF_TYPE_MESSAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getObjectName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.70">getObjectName</a>()</pre>
<div class="block">Returns the <code>ObjectName</code> that this status logger mbean is registered with.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ObjectName of this StatusLogger MBean</dd>
</dl>
</li>
</ul>
<a name="getStatusData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusData</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.logging.log4j.status.StatusData&gt;&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.88">getStatusData</a>()</pre>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the most recent messages logged by the <code>StatusLogger</code>.</dd>
</dl>
</li>
</ul>
<a name="getStatusDataHistory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusDataHistory</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.97">getStatusDataHistory</a>()</pre>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the most recent messages logged by the <code>StatusLogger</code>.</dd>
</dl>
</li>
</ul>
<a name="getLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLevel</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.104">getLevel</a>()</pre>
<div class="block">Returns the <code>StatusLogger</code> level as a String.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>StatusLogger</code> level.</dd>
</dl>
</li>
</ul>
<a name="setLevel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLevel</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.114">setLevel</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;level)</pre>
<div class="block">Sets the <code>StatusLogger</code> level to the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - the new <code>StatusLogger</code> level.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the specified level is not one of
"OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE",
"ALL"</dd>
</dl>
</li>
</ul>
<a name="getContextName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getContextName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html#line.120">getContextName</a>()</pre>
<div class="block">Returns the name of the LoggerContext that the <code>StatusLogger</code> is associated with.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>logger context name</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StatusLoggerAdminMBean.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/jmx/StatusLoggerAdmin.html" title="class in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/jmx/StatusLoggerAdminMBean.html" target="_top">Frames</a></li>
<li><a href="StatusLoggerAdminMBean.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <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>
</body>
</html>