| <!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 Sun May 10 12:47:46 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AsyncAppenderAdmin (Apache Log4j Core 2.13.3 API)</title> |
| <meta name="date" content="2020-05-10"> |
| <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="AsyncAppenderAdmin (Apache Log4j Core 2.13.3 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}; |
| 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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/jmx/AppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html" target="_top">Frames</a></li> |
| <li><a href="AsyncAppenderAdmin.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 AsyncAppenderAdmin" class="title">Class AsyncAppenderAdmin</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>org.apache.logging.log4j.core.jmx.AsyncAppenderAdmin</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#line.28">AsyncAppenderAdmin</a> |
| extends <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> |
| implements <a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></pre> |
| <div class="block">Implementation of the <code>AsyncAppenderAdminMBean</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.AsyncAppenderAdminMBean"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.logging.log4j.core.jmx.<a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.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"> </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/AsyncAppenderAdmin.html#AsyncAppenderAdmin-java.lang.String-org.apache.logging.log4j.core.appender.AsyncAppender-">AsyncAppenderAdmin</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> contextName, |
| <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a> appender)</code> |
| <div class="block">Constructs a new <code>AsyncAppenderAdmin</code> with the specified contextName |
| and async appender.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/AsyncAppenderAdmin.html#getAppenderRefs--">getAppenderRefs</a></span>()</code> |
| <div class="block">Returns a String array with the appender refs configured for the |
| instrumented <code>AsyncAppender</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/AsyncAppenderAdmin.html#getErrorHandler--">getErrorHandler</a></span>()</code> |
| <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> |
| </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/AsyncAppenderAdmin.html#getErrorRef--">getErrorRef</a></span>()</code> |
| <div class="block">Returns the name of the appender that any errors are logged to or <code>null</code>.</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/AsyncAppenderAdmin.html#getFilter--">getFilter</a></span>()</code> |
| <div class="block">Returns a string description of all filters configured for the |
| instrumented <code>AsyncAppender</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#getLayout--">getLayout</a></span>()</code> |
| <div class="block">Returns the result of calling <code>toString</code> on the <code>Layout</code> |
| object of the instrumented <code>AsyncAppender</code>.</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/AsyncAppenderAdmin.html#getName--">getName</a></span>()</code> |
| <div class="block">Returns the name of the instrumented <code>AsyncAppender</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/AsyncAppenderAdmin.html#getObjectName--">getObjectName</a></span>()</code> |
| <div class="block">Returns the <code>ObjectName</code> of this mbean.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#getQueueCapacity--">getQueueCapacity</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#getQueueRemainingCapacity--">getQueueRemainingCapacity</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#isBlocking--">isBlocking</a></span>()</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#isIgnoreExceptions--">isIgnoreExceptions</a></span>()</code> |
| <div class="block">Returns how exceptions thrown on the instrumented <code>AsyncAppender</code> |
| are handled.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#isIncludeLocation--">isIncludeLocation</a></span>()</code> |
| <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> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="AsyncAppenderAdmin-java.lang.String-org.apache.logging.log4j.core.appender.AsyncAppender-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AsyncAppenderAdmin</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#line.41">AsyncAppenderAdmin</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> contextName, |
| <a href="../../../../../../org/apache/logging/log4j/core/appender/AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a> appender)</pre> |
| <div class="block">Constructs a new <code>AsyncAppenderAdmin</code> with the specified contextName |
| and async appender.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contextName</code> - used in the <code>ObjectName</code> for this mbean</dd> |
| <dd><code>appender</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="getObjectName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectName</h4> |
| <pre>public <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> <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#line.61">getObjectName</a>()</pre> |
| <div class="block">Returns the <code>ObjectName</code> of this mbean.</div> |
| <dl> |
| <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/AppenderAdminMBean.html#PATTERN"><code>AppenderAdminMBean.PATTERN</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <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/AsyncAppenderAdmin.html#line.66">getName</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getName--">AsyncAppenderAdminMBean</a></code></span></div> |
| <div class="block">Returns the name of the instrumented <code>AsyncAppender</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getName--">getName</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the AsyncAppender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLayout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLayout</h4> |
| <pre>public <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/AsyncAppenderAdmin.html#line.71">getLayout</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getLayout--">getLayout</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Layout</code> of the instrumented <code>AsyncAppender</code> as a |
| string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isIgnoreExceptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIgnoreExceptions</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#line.76">isIgnoreExceptions</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#isIgnoreExceptions--">isIgnoreExceptions</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a name="getErrorHandler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getErrorHandler</h4> |
| <pre>public <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/AsyncAppenderAdmin.html#line.81">getErrorHandler</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getErrorHandler--">getErrorHandler</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>result of calling <code>toString</code> on the error handler of this |
| appender, or <code>"null"</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilter</h4> |
| <pre>public <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/AsyncAppenderAdmin.html#line.86">getFilter</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getFilter--">getFilter</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string description of all configured filters for this appender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAppenderRefs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAppenderRefs</h4> |
| <pre>public <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/AsyncAppenderAdmin.html#line.91">getAppenderRefs</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getAppenderRefs--">getAppenderRefs</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the appender refs for the instrumented <code>AsyncAppender</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isIncludeLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIncludeLocation</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#line.102">isIncludeLocation</a>()</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#isIncludeLocation--">isIncludeLocation</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if location is included with every event, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isBlocking--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBlocking</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#line.112">isBlocking</a>()</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#isBlocking--">isBlocking</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this AsyncAppender will block or drop events when the queue is full.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getErrorRef--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getErrorRef</h4> |
| <pre>public <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/AsyncAppenderAdmin.html#line.121">getErrorRef</a>()</pre> |
| <div class="block">Returns the name of the appender that any errors are logged to or <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getErrorRef--">getErrorRef</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the appender that any errors are logged to or <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueueCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueueCapacity</h4> |
| <pre>public int <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#line.126">getQueueCapacity</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getQueueCapacity--">getQueueCapacity</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueueRemainingCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getQueueRemainingCapacity</h4> |
| <pre>public int <a href="../../../../../../src-html/org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html#line.131">getQueueRemainingCapacity</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html#getQueueRemainingCapacity--">getQueueRemainingCapacity</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx">AsyncAppenderAdminMBean</a></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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/jmx/AppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/jmx/AsyncAppenderAdminMBean.html" title="interface in org.apache.logging.log4j.core.jmx"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/jmx/AsyncAppenderAdmin.html" target="_top">Frames</a></li> |
| <li><a href="AsyncAppenderAdmin.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |