blob: 98d5154bbab6ba0e7589003b79b053210b963910 [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 Wed Dec 11 21:08:55 MST 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LoggerConfigAdminMBean (Apache Log4j Core 2.13.0 API)</title>
<meta name="date" content="2019-12-11">
<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="LoggerConfigAdminMBean (Apache Log4j Core 2.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/LoggerConfigAdminMBean.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/LoggerConfigAdmin.html" title="class in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html" title="class in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html" target="_top">Frames</a></li>
<li><a href="LoggerConfigAdminMBean.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 LoggerConfigAdminMBean" class="title">Interface LoggerConfigAdminMBean</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/LoggerConfigAdmin.html" title="class in org.apache.logging.log4j.core.jmx">LoggerConfigAdmin</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html#line.22">LoggerConfigAdminMBean</a></pre>
<div class="block">The MBean interface for monitoring and managing a <code>LoggerConfig</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/LoggerConfigAdminMBean.html#PATTERN">PATTERN</a></span></code>
<div class="block">ObjectName pattern ("org.apache.logging.log4j2:type=%s,component=Loggers,name=%s") for LoggerConfigAdmin 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/LoggerConfigAdminMBean.html#getAppenderRefs--">getAppenderRefs</a></span>()</code>
<div class="block">Returns a String array with the appender refs configured for the
instrumented <code>LoggerConfig</code>.</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/LoggerConfigAdminMBean.html#getFilter--">getFilter</a></span>()</code>
<div class="block">Returns a string description of all filters configured for the
instrumented <code>LoggerConfig</code>.</div>
</td>
</tr>
<tr id="i2" 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/LoggerConfigAdminMBean.html#getLevel--">getLevel</a></span>()</code>
<div class="block">Returns the <code>LoggerConfig</code> level as a String.</div>
</td>
</tr>
<tr id="i3" 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/LoggerConfigAdminMBean.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of the instrumented <code>LoggerConfig</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html#isAdditive--">isAdditive</a></span>()</code>
<div class="block">Returns whether the instrumented <code>LoggerConfig</code> is additive.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html#isIncludeLocation--">isIncludeLocation</a></span>()</code>
<div class="block">Returns whether the instrumented <code>LoggerConfig</code> is configured to
include location.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html#setAdditive-boolean-">setAdditive</a></span>(boolean&nbsp;additive)</code>
<div class="block">Sets whether the instrumented <code>LoggerConfig</code> should be additive.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.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>LoggerConfig</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="blockListLast">
<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/LoggerConfigAdminMBean.html#line.48">PATTERN</a></pre>
<div class="block">ObjectName pattern ("org.apache.logging.log4j2:type=%s,component=Loggers,name=%s") for LoggerConfigAdmin MBeans.
This pattern contains two variables, where the first is the name of the
context, the second is the name of the instrumented logger config.
<p>
You can find all registered LoggerConfigAdmin MBeans like this:
</p>
<pre>
MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
String pattern = String.format(LoggerConfigAdminMBean.PATTERN, &quot;*&quot;, &quot;*&quot;);
Set&lt;ObjectName&gt; loggerConfigNames = mbs.queryNames(new ObjectName(pattern), null);
</pre>
<p>
Some characters are not allowed in ObjectNames. The logger context name
and logger config name may be quoted. When LoggerConfigAdmin MBeans are
registered, their ObjectNames are created using this pattern as follows:
</p>
<pre>
String ctxName = Server.escape(loggerContext.getName());
String loggerConfigName = Server.escape(loggerConfig.getName());
String name = String.format(PATTERN, ctxName, loggerConfigName);
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.LoggerConfigAdminMBean.PATTERN">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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</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/LoggerConfigAdminMBean.html#line.55">getName</a>()</pre>
<div class="block">Returns the name of the instrumented <code>LoggerConfig</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the LoggerConfig</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/LoggerConfigAdminMBean.html#line.62">getLevel</a>()</pre>
<div class="block">Returns the <code>LoggerConfig</code> level as a String.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>LoggerConfig</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/LoggerConfigAdminMBean.html#line.72">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>LoggerConfig</code> level to the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - the new <code>LoggerConfig</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="isAdditive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAdditive</h4>
<pre>boolean&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html#line.80">isAdditive</a>()</pre>
<div class="block">Returns whether the instrumented <code>LoggerConfig</code> is additive.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the LoggerConfig is additive, <code>false</code>
otherwise</dd>
</dl>
</li>
</ul>
<a name="setAdditive-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAdditive</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html#line.88">setAdditive</a>(boolean&nbsp;additive)</pre>
<div class="block">Sets whether the instrumented <code>LoggerConfig</code> should be additive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>additive</code> - <code>true</code> if the instrumented LoggerConfig should be
additive, <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="isIncludeLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIncludeLocation</h4>
<pre>boolean&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html#line.96">isIncludeLocation</a>()</pre>
<div class="block">Returns whether the instrumented <code>LoggerConfig</code> is configured to
include location.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether location should be passed downstream</dd>
</dl>
</li>
</ul>
<a name="getFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</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/LoggerConfigAdminMBean.html#line.105">getFilter</a>()</pre>
<div class="block">Returns a string description of all filters configured for the
instrumented <code>LoggerConfig</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string description of all configured filters for this
LoggerConfig</dd>
</dl>
</li>
</ul>
<a name="getAppenderRefs--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAppenderRefs</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/LoggerConfigAdminMBean.html#line.113">getAppenderRefs</a>()</pre>
<div class="block">Returns a String array with the appender refs configured for the
instrumented <code>LoggerConfig</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the appender refs for the instrumented <code>LoggerConfig</code>.</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/LoggerConfigAdminMBean.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/LoggerConfigAdmin.html" title="class in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html" title="class in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/jmx/LoggerConfigAdminMBean.html" target="_top">Frames</a></li>
<li><a href="LoggerConfigAdminMBean.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-2019 <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>