| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AsyncAppenderAdmin (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: AsyncAppenderAdmin"> |
| <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/AsyncAppenderAdmin.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 AsyncAppenderAdmin" class="title">Class AsyncAppenderAdmin</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">org.apache.logging.log4j.core.jmx.AsyncAppenderAdmin</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AsyncAppenderAdmin</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></span></div> |
| <div class="block">Implementation of the <code>AsyncAppenderAdminMBean</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.AsyncAppenderAdminMBean">Fields inherited from interface org.apache.logging.log4j.core.jmx.<a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></h3> |
| <code><a href="AsyncAppenderAdminMBean.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,org.apache.logging.log4j.core.appender.AsyncAppender)" class="member-name-link">AsyncAppenderAdmin</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="../appender/AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a> appender)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a new <code>AsyncAppenderAdmin</code> with the specified contextName |
| and async appender.</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><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="#getAppenderRefs()" class="member-name-link">getAppenderRefs</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 appender refs configured for the |
| instrumented <code>AsyncAppender</code>.</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="#getErrorHandler()" class="member-name-link">getErrorHandler</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 result of calling <code>toString</code> on the error handler of |
| this appender, or <code>"null"</code> if no error handler was set.</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="#getErrorRef()" class="member-name-link">getErrorRef</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 appender that any errors are logged to or <code>null</code>.</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="#getFilter()" class="member-name-link">getFilter</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 string description of all filters configured for the |
| instrumented <code>AsyncAppender</code>.</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="#getLayout()" class="member-name-link">getLayout</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 result of calling <code>toString</code> on the <code>Layout</code> |
| object of the instrumented <code>AsyncAppender</code>.</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="#getName()" class="member-name-link">getName</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 name of the instrumented <code>AsyncAppender</code>.</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>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQueueCapacity()" class="member-name-link">getQueueCapacity</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>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQueueRemainingCapacity()" class="member-name-link">getQueueRemainingCapacity</a>()</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>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isBlocking()" class="member-name-link">isBlocking</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 <code>true</code> if this AsyncAppender will block when the queue is full, |
| or <code>false</code> if events are dropped when the queue is full.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isIgnoreExceptions()" class="member-name-link">isIgnoreExceptions</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 how exceptions thrown on the instrumented <code>AsyncAppender</code> |
| are handled.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isIncludeLocation()" class="member-name-link">isIncludeLocation</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 <code>true</code> if this AsyncAppender will take a snapshot of the stack with |
| every log event to determine the class and method where the logging call |
| was made.</div> |
| </div> |
| </div> |
| </div> |
| </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,org.apache.logging.log4j.core.appender.AsyncAppender)"> |
| <h3>AsyncAppenderAdmin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AsyncAppenderAdmin</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="../appender/AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a> appender)</span></div> |
| <div class="block">Constructs a new <code>AsyncAppenderAdmin</code> with the specified contextName |
| and async appender.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>contextName</code> - used in the <code>ObjectName</code> for this mbean</dd> |
| <dd><code>appender</code> - the instrumented object</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="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>Returns:</dt> |
| <dd>the <code>ObjectName</code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="AppenderAdminMBean.html#PATTERN"><code>AppenderAdminMBean.PATTERN</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</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">getName</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="AsyncAppenderAdminMBean.html#getName()">AsyncAppenderAdminMBean</a></code></span></div> |
| <div class="block">Returns the name of the instrumented <code>AsyncAppender</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#getName()">getName</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the name of the AsyncAppender</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLayout()"> |
| <h3>getLayout</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">getLayout</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="AsyncAppenderAdminMBean.html#getLayout()">AsyncAppenderAdminMBean</a></code></span></div> |
| <div class="block">Returns the result of calling <code>toString</code> on the <code>Layout</code> |
| object of the instrumented <code>AsyncAppender</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#getLayout()">getLayout</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <code>Layout</code> of the instrumented <code>AsyncAppender</code> as a |
| string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isIgnoreExceptions()"> |
| <h3>isIgnoreExceptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isIgnoreExceptions</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="AsyncAppenderAdminMBean.html#isIgnoreExceptions()">AsyncAppenderAdminMBean</a></code></span></div> |
| <div class="block">Returns how exceptions thrown on the instrumented <code>AsyncAppender</code> |
| are handled.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#isIgnoreExceptions()">isIgnoreExceptions</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if any exceptions thrown by the AsyncAppender will |
| be logged or <code>false</code> if such exceptions are re-thrown.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getErrorHandler()"> |
| <h3>getErrorHandler</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">getErrorHandler</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="AsyncAppenderAdminMBean.html#getErrorHandler()">AsyncAppenderAdminMBean</a></code></span></div> |
| <div class="block">Returns the result of calling <code>toString</code> on the error handler of |
| this appender, or <code>"null"</code> if no error handler was set.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#getErrorHandler()">getErrorHandler</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>result of calling <code>toString</code> on the error handler of this |
| appender, or <code>"null"</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFilter()"> |
| <h3>getFilter</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">getFilter</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="AsyncAppenderAdminMBean.html#getFilter()">AsyncAppenderAdminMBean</a></code></span></div> |
| <div class="block">Returns a string description of all filters configured for the |
| instrumented <code>AsyncAppender</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#getFilter()">getFilter</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a string description of all configured filters for this appender</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAppenderRefs()"> |
| <h3>getAppenderRefs</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">getAppenderRefs</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="AsyncAppenderAdminMBean.html#getAppenderRefs()">AsyncAppenderAdminMBean</a></code></span></div> |
| <div class="block">Returns a String array with the appender refs configured for the |
| instrumented <code>AsyncAppender</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#getAppenderRefs()">getAppenderRefs</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the appender refs for the instrumented <code>AsyncAppender</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isIncludeLocation()"> |
| <h3>isIncludeLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isIncludeLocation</span>()</div> |
| <div class="block">Returns <code>true</code> if this AsyncAppender will take a snapshot of the stack with |
| every log event to determine the class and method where the logging call |
| was made.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#isIncludeLocation()">isIncludeLocation</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if location is included with every event, <code>false</code> otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBlocking()"> |
| <h3>isBlocking</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isBlocking</span>()</div> |
| <div class="block">Returns <code>true</code> if this AsyncAppender will block when the queue is full, |
| or <code>false</code> if events are dropped when the queue is full.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#isBlocking()">isBlocking</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether this AsyncAppender will block or drop events when the queue is full.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getErrorRef()"> |
| <h3>getErrorRef</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">getErrorRef</span>()</div> |
| <div class="block">Returns the name of the appender that any errors are logged to or <code>null</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#getErrorRef()">getErrorRef</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the name of the appender that any errors are logged to or <code>null</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQueueCapacity()"> |
| <h3>getQueueCapacity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getQueueCapacity</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#getQueueCapacity()">getQueueCapacity</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQueueRemainingCapacity()"> |
| <h3>getQueueRemainingCapacity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getQueueRemainingCapacity</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AsyncAppenderAdminMBean.html#getQueueRemainingCapacity()">getQueueRemainingCapacity</a></code> in interface <code><a href="AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</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> |
