blob: 9684101dec8ea9fc57990bd44d51bca7956dab70 [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>LoggerContextAdmin (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="LoggerContextAdmin (Apache Log4j Core 2.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/LoggerContextAdmin.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/LoggerConfigAdminMBean.html" title="interface 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/LoggerContextAdminMBean.html" title="interface 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/LoggerContextAdmin.html" target="_top">Frames</a></li>
<li><a href="LoggerContextAdmin.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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="Class LoggerContextAdmin" class="title">Class LoggerContextAdmin</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true" title="class or interface in javax.management">javax.management.NotificationBroadcasterSupport</a></li>
<li>
<ul class="inheritance">
<li>org.apache.logging.log4j.core.jmx.LoggerContextAdmin</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcaster.html?is-external=true" title="class or interface in javax.management">NotificationBroadcaster</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationEmitter.html?is-external=true" title="class or interface in javax.management">NotificationEmitter</a>, <a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.55">LoggerContextAdmin</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true" title="class or interface in javax.management">NotificationBroadcasterSupport</a>
implements <a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a></pre>
<div class="block">Implementation of the <code>LoggerContextAdminMBean</code> interface.</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.jmx.LoggerContextAdminMBean">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.logging.log4j.core.jmx.<a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#NOTIF_TYPE_RECONFIGURED">NOTIF_TYPE_RECONFIGURED</a>, <a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#PATTERN">PATTERN</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#LoggerContextAdmin-org.apache.logging.log4j.core.LoggerContext-java.util.concurrent.Executor-">LoggerContextAdmin</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a>&nbsp;loggerContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;executor)</code>
<div class="block">Constructs a new <code>LoggerContextAdmin</code> with the <code>Executor</code> to be used for sending <code>Notification</code>
s asynchronously to listeners.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/LoggerContextAdmin.html#getConfigClassName--">getConfigClassName</a></span>()</code>
<div class="block">Returns the class name of the <code>Configuration</code> of the instrumented
LoggerContext.</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/LoggerContextAdmin.html#getConfigFilter--">getConfigFilter</a></span>()</code>
<div class="block">Returns a string description of all Filters configured in the
<code>Configuration</code> of the instrumented LoggerContext.</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/LoggerContextAdmin.html#getConfigLocationUri--">getConfigLocationUri</a></span>()</code>
<div class="block">Returns the configuration location URI 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/LoggerContextAdmin.html#getConfigName--">getConfigName</a></span>()</code>
<div class="block">Returns the name of the Configuration of the instrumented LoggerContext.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#getConfigProperties--">getConfigProperties</a></span>()</code>
<div class="block">Returns a map with configured properties.</div>
</td>
</tr>
<tr id="i5" 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/LoggerContextAdmin.html#getConfigText--">getConfigText</a></span>()</code>
<div class="block">Returns the configuration text, which may be the contents of the
configuration file or the text that was last set with a call to
<code>setConfigText</code>.</div>
</td>
</tr>
<tr id="i6" 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/LoggerContextAdmin.html#getConfigText-java.lang.String-">getConfigText</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;charsetName)</code>
<div class="block">Returns the configuration text, which may be the contents of the
configuration file or the text that was last set with a call to
<code>setConfigText</code>.</div>
</td>
</tr>
<tr id="i7" 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/LoggerContextAdmin.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of the instrumented <code>LoggerContext</code>.</div>
</td>
</tr>
<tr id="i8" 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/LoggerContextAdmin.html#getObjectName--">getObjectName</a></span>()</code>
<div class="block">Returns the <code>ObjectName</code> of this mbean.</div>
</td>
</tr>
<tr id="i9" 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/LoggerContextAdmin.html#getStatus--">getStatus</a></span>()</code>
<div class="block">Returns the status of the instrumented <code>LoggerContext</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#propertyChange-java.beans.PropertyChangeEvent-">propertyChange</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html?is-external=true" title="class or interface in java.beans">PropertyChangeEvent</a>&nbsp;evt)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#setConfigLocationUri-java.lang.String-">setConfigLocationUri</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;configLocation)</code>
<div class="block">Sets the configuration location to the specified URI.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#setConfigText-java.lang.String-java.lang.String-">setConfigText</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;configText,
<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;charsetName)</code>
<div class="block">Sets the configuration text.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.management.NotificationBroadcasterSupport">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;javax.management.<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true" title="class or interface in javax.management">NotificationBroadcasterSupport</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true#addNotificationListener-javax.management.NotificationListener-javax.management.NotificationFilter-java.lang.Object-" title="class or interface in javax.management">addNotificationListener</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true#getNotificationInfo--" title="class or interface in javax.management">getNotificationInfo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true#handleNotification-javax.management.NotificationListener-javax.management.Notification-java.lang.Object-" title="class or interface in javax.management">handleNotification</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true#removeNotificationListener-javax.management.NotificationListener-" title="class or interface in javax.management">removeNotificationListener</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true#removeNotificationListener-javax.management.NotificationListener-javax.management.NotificationFilter-java.lang.Object-" title="class or interface in javax.management">removeNotificationListener</a>, <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/NotificationBroadcasterSupport.html?is-external=true#sendNotification-javax.management.Notification-" title="class or interface in javax.management">sendNotification</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LoggerContextAdmin-org.apache.logging.log4j.core.LoggerContext-java.util.concurrent.Executor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LoggerContextAdmin</h4>
<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.73">LoggerContextAdmin</a>(<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a>&nbsp;loggerContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;executor)</pre>
<div class="block">Constructs a new <code>LoggerContextAdmin</code> with the <code>Executor</code> to be used for sending <code>Notification</code>
s asynchronously to listeners.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executor</code> - used to send notifications asynchronously</dd>
<dd><code>loggerContext</code> - the instrumented object</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="getStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</h4>
<pre>public&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>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.94">getStatus</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getStatus--">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns the status of the instrumented <code>LoggerContext</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getStatus--">getStatus</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the LoggerContext status.</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&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>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.99">getName</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getName--">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns the name of the instrumented <code>LoggerContext</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getName--">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the instrumented <code>LoggerContext</code>.</dd>
</dl>
</li>
</ul>
<a name="getConfigLocationUri--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigLocationUri</h4>
<pre>public&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>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.108">getConfigLocationUri</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigLocationUri--">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns the configuration location URI as a String.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigLocationUri--">getConfigLocationUri</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configuration location</dd>
</dl>
</li>
</ul>
<a name="setConfigLocationUri-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigLocationUri</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.119">setConfigLocationUri</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;configLocation)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URISyntaxException.html?is-external=true" title="class or interface in java.net">URISyntaxException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#setConfigLocationUri-java.lang.String-">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Sets the configuration location to the specified URI. This will cause the
instrumented <code>LoggerContext</code> to reconfigure.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#setConfigLocationUri-java.lang.String-">setConfigLocationUri</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configLocation</code> - location of the configuration file in
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> format.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URISyntaxException.html?is-external=true" title="class or interface in java.net">URISyntaxException</a></code> - if the format of the specified
configLocationURI is incorrect</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an error occurred reading the specified location</dd>
</dl>
</li>
</ul>
<a name="propertyChange-java.beans.PropertyChangeEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propertyChange</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.141">propertyChange</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html?is-external=true" title="class or interface in java.beans">PropertyChangeEvent</a>&nbsp;evt)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html?is-external=true#propertyChange-java.beans.PropertyChangeEvent-" title="class or interface in java.beans">propertyChange</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a></code></dd>
</dl>
</li>
</ul>
<a name="getConfigText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigText</h4>
<pre>public&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>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.150">getConfigText</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigText--">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns the configuration text, which may be the contents of the
configuration file or the text that was last set with a call to
<code>setConfigText</code>. If reading a file, this method assumes the file's
character encoding is UTF-8.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigText--">getConfigText</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configuration text</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if a problem occurred reading the contents of the
config file.</dd>
</dl>
</li>
</ul>
<a name="getConfigText-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigText</h4>
<pre>public&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>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.155">getConfigText</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;charsetName)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigText-java.lang.String-">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns the configuration text, which may be the contents of the
configuration file or the text that was last set with a call to
<code>setConfigText</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigText-java.lang.String-">getConfigText</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>charsetName</code> - the encoding to use to convert the file's bytes into
the resulting string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configuration text</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if a problem occurred reading the contents of the
config file.</dd>
</dl>
</li>
</ul>
<a name="setConfigText-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigText</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.193">setConfigText</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;configText,
<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;charsetName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#setConfigText-java.lang.String-java.lang.String-">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Sets the configuration text. This does not replace the contents of the
configuration file, but <em>does</em> cause the instrumented
<code>LoggerContext</code> to be reconfigured with the specified text.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#setConfigText-java.lang.String-java.lang.String-">setConfigText</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configText</code> - the configuration text in XML or JSON format</dd>
<dd><code>charsetName</code> - name of the <code>Charset</code> used to convert the
specified configText to bytes</dd>
</dl>
</li>
</ul>
<a name="getConfigName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigName</h4>
<pre>public&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>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.211">getConfigName</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigName--">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns the name of the Configuration of the instrumented LoggerContext.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigName--">getConfigName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Configuration name</dd>
</dl>
</li>
</ul>
<a name="getConfigClassName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigClassName</h4>
<pre>public&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>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.216">getConfigClassName</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigClassName--">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns the class name of the <code>Configuration</code> of the instrumented
LoggerContext.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigClassName--">getConfigClassName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the class name of the <code>Configuration</code>.</dd>
</dl>
</li>
</ul>
<a name="getConfigFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigFilter</h4>
<pre>public&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>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.221">getConfigFilter</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigFilter--">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns a string description of all Filters configured in the
<code>Configuration</code> of the instrumented LoggerContext.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigFilter--">getConfigFilter</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string description of all Filters configured</dd>
</dl>
</li>
</ul>
<a name="getConfigProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigProperties</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/LoggerContextAdmin.html#line.226">getConfigProperties</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigProperties--">LoggerContextAdminMBean</a></code></span></div>
<div class="block">Returns a map with configured properties.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getConfigProperties--">getConfigProperties</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map with configured properties.</dd>
</dl>
</li>
</ul>
<a name="getObjectName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getObjectName</h4>
<pre>public&nbsp;<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/LoggerContextAdmin.html#line.237">getObjectName</a>()</pre>
<div class="block">Returns the <code>ObjectName</code> of this mbean.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#getObjectName--">getObjectName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">LoggerContextAdminMBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>ObjectName</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/jmx/LoggerContextAdminMBean.html#PATTERN"><code>LoggerContextAdminMBean.PATTERN</code></a></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/LoggerContextAdmin.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/LoggerConfigAdminMBean.html" title="interface 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/LoggerContextAdminMBean.html" title="interface 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/LoggerContextAdmin.html" target="_top">Frames</a></li>
<li><a href="LoggerContextAdmin.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>