| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AsyncLoggerContext (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.async, class: AsyncLoggerContext"> |
| <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/AsyncLoggerContext.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><a href="#nested-class-summary">Nested</a> | </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.async</a></div> |
| <h1 title="Class AsyncLoggerContext" class="title">Class AsyncLoggerContext</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"><a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.AbstractLifeCycle</a> |
| <div class="inheritance"><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.LoggerContext</a> |
| <div class="inheritance">org.apache.logging.log4j.core.async.AsyncLoggerContext</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../config/ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a></code>, <code><a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code>, <code><a href="../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContext</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextShutdownEnabled.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextShutdownEnabled</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/Terminable.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">Terminable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AsyncLoggerContext</span> |
| <span class="extends-implements">extends <a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span></div> |
| <div class="block"><code>LoggerContext</code> that creates <code>AsyncLogger</code> objects.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.<a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h2> |
| <code><a href="../LifeCycle.State.html" title="enum in org.apache.logging.log4j.core">LifeCycle.State</a></code></div> |
| </section> |
| </li> |
| <!-- =========== 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.LoggerContext">Fields inherited from class org.apache.logging.log4j.core.<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></h3> |
| <code><a href="../LoggerContext.html#PROPERTY_CONFIG">PROPERTY_CONFIG</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Fields inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#DEFAULT_STOP_TIMEOUT">DEFAULT_STOP_TIMEOUT</a>, <a href="../AbstractLifeCycle.html#DEFAULT_STOP_TIMEUNIT">DEFAULT_STOP_TIMEUNIT</a>, <a href="../AbstractLifeCycle.html#LOGGER">LOGGER</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.spi.LoggerContext">Fields inherited from interface org.apache.logging.log4j.spi.<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContext</a></h3> |
| <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#EMPTY_ARRAY" title="class or interface in org.apache.logging.log4j.spi" class="external-link">EMPTY_ARRAY</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)" class="member-name-link">AsyncLoggerContext</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> name)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.Object)" class="member-name-link">AsyncLoggerContext</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> name, |
| <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> externalContext)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.Object,java.lang.String)" class="member-name-link">AsyncLoggerContext</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> name, |
| <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> externalContext, |
| <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> configLocn)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.Object,java.net.URI)" class="member-name-link">AsyncLoggerContext</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> name, |
| <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> externalContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> configLocn)</code></div> |
| <div class="col-last odd-row-color"> </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="../jmx/RingBufferAdmin.html" title="class in org.apache.logging.log4j.core.jmx">RingBufferAdmin</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createRingBufferAdmin()" class="member-name-link">createRingBufferAdmin</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates and returns a new <code>RingBufferAdmin</code> that instruments the ringbuffer of the <code>AsyncLogger</code> |
| objects in this <code>LoggerContext</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newInstance(org.apache.logging.log4j.core.LoggerContext,java.lang.String,org.apache.logging.log4j.message.MessageFactory)" class="member-name-link">newInstance</a><wbr>(<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> ctx, |
| <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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/MessageFactory.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">MessageFactory</a> messageFactory)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setName(java.lang.String)" class="member-name-link">setName</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUseThreadLocals(boolean)" class="member-name-link">setUseThreadLocals</a><wbr>(boolean useThreadLocals)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Signals this context whether it is allowed to use ThreadLocal objects for efficiency.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" class="member-name-link">start</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start(org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">start</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Starts with a specific configuration.</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="#stop(long,java.util.concurrent.TimeUnit)" class="member-name-link">stop</a><wbr>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Blocks until all Log4j tasks have completed execution after a shutdown request and all appenders have shut down, |
| or the timeout occurs, or the current thread is interrupted, whichever happens first.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.LoggerContext">Methods inherited from class org.apache.logging.log4j.core.<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></h3> |
| <code><a href="../LoggerContext.html#addFilter(org.apache.logging.log4j.core.Filter)">addFilter</a>, <a href="../LoggerContext.html#addPropertyChangeListener(java.beans.PropertyChangeListener)">addPropertyChangeListener</a>, <a href="../LoggerContext.html#addShutdownListener(org.apache.logging.log4j.spi.LoggerContextShutdownAware)">addShutdownListener</a>, <a href="../LoggerContext.html#close()">close</a>, <a href="../LoggerContext.html#getConfigLocation()">getConfigLocation</a>, <a href="../LoggerContext.html#getConfiguration()">getConfiguration</a>, <a href="../LoggerContext.html#getContext()">getContext</a>, <a href="../LoggerContext.html#getContext(boolean)">getContext</a>, <a href="../LoggerContext.html#getContext(java.lang.ClassLoader,boolean,java.net.URI)">getContext</a>, <a href="../LoggerContext.html#getExternalContext()">getExternalContext</a>, <a href="../LoggerContext.html#getListeners()">getListeners</a>, <a href="../LoggerContext.html#getLogger(java.lang.String)">getLogger</a>, <a href="../LoggerContext.html#getLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)">getLogger</a>, <a href="../LoggerContext.html#getLoggerRegistry()">getLoggerRegistry</a>, <a href="../LoggerContext.html#getLoggers()">getLoggers</a>, <a href="../LoggerContext.html#getName()">getName</a>, <a href="../LoggerContext.html#getObject(java.lang.String)">getObject</a>, <a href="../LoggerContext.html#getRootLogger()">getRootLogger</a>, <a href="../LoggerContext.html#hasLogger(java.lang.String)">hasLogger</a>, <a href="../LoggerContext.html#hasLogger(java.lang.String,java.lang.Class)">hasLogger</a>, <a href="../LoggerContext.html#hasLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)">hasLogger</a>, <a href="../LoggerContext.html#onChange(org.apache.logging.log4j.core.config.Reconfigurable)">onChange</a>, <a href="../LoggerContext.html#putObject(java.lang.String,java.lang.Object)">putObject</a>, <a href="../LoggerContext.html#putObjectIfAbsent(java.lang.String,java.lang.Object)">putObjectIfAbsent</a>, <a href="../LoggerContext.html#reconfigure()">reconfigure</a>, <a href="../LoggerContext.html#reconfigure(org.apache.logging.log4j.core.config.Configuration)">reconfigure</a>, <a href="../LoggerContext.html#removeFilter(org.apache.logging.log4j.core.Filter)">removeFilter</a>, <a href="../LoggerContext.html#removeObject(java.lang.String)">removeObject</a>, <a href="../LoggerContext.html#removeObject(java.lang.String,java.lang.Object)">removeObject</a>, <a href="../LoggerContext.html#removePropertyChangeListener(java.beans.PropertyChangeListener)">removePropertyChangeListener</a>, <a href="../LoggerContext.html#setConfigLocation(java.net.URI)">setConfigLocation</a>, <a href="../LoggerContext.html#setConfiguration(org.apache.logging.log4j.core.config.Configuration)">setConfiguration</a>, <a href="../LoggerContext.html#setExternalContext(java.lang.Object)">setExternalContext</a>, <a href="../LoggerContext.html#terminate()">terminate</a>, <a href="../LoggerContext.html#updateLoggers()">updateLoggers</a>, <a href="../LoggerContext.html#updateLoggers(org.apache.logging.log4j.core.config.Configuration)">updateLoggers</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Methods inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#equalsImpl(java.lang.Object)">equalsImpl</a>, <a href="../AbstractLifeCycle.html#getState()">getState</a>, <a href="../AbstractLifeCycle.html#getStatusLogger()">getStatusLogger</a>, <a href="../AbstractLifeCycle.html#hashCodeImpl()">hashCodeImpl</a>, <a href="../AbstractLifeCycle.html#initialize()">initialize</a>, <a href="../AbstractLifeCycle.html#isInitialized()">isInitialized</a>, <a href="../AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../AbstractLifeCycle.html#setStarted()">setStarted</a>, <a href="../AbstractLifeCycle.html#setStarting()">setStarting</a>, <a href="../AbstractLifeCycle.html#setState(org.apache.logging.log4j.core.LifeCycle.State)">setState</a>, <a href="../AbstractLifeCycle.html#setStopped()">setStopped</a>, <a href="../AbstractLifeCycle.html#setStopping()">setStopping</a>, <a href="../AbstractLifeCycle.html#stop()">stop</a>, <a href="../AbstractLifeCycle.html#stop(java.util.concurrent.Future)">stop</a></code></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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.spi.LoggerContext">Methods inherited from interface org.apache.logging.log4j.spi.<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContext</a></h3> |
| <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#getLogger(java.lang.Class)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getLogger</a>, <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#getLogger(java.lang.Class,org.apache.logging.log4j.message.MessageFactory)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getLogger</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)"> |
| <h3>AsyncLoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AsyncLoggerContext</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> name)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.Object)"> |
| <h3>AsyncLoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AsyncLoggerContext</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> name, |
| <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> externalContext)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.Object,java.net.URI)"> |
| <h3>AsyncLoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AsyncLoggerContext</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> name, |
| <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> externalContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> configLocn)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.Object,java.lang.String)"> |
| <h3>AsyncLoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AsyncLoggerContext</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> name, |
| <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> externalContext, |
| <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> configLocn)</span></div> |
| </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="newInstance(org.apache.logging.log4j.core.LoggerContext,java.lang.String,org.apache.logging.log4j.message.MessageFactory)"> |
| <h3>newInstance</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> ctx, |
| <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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/MessageFactory.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">MessageFactory</a> messageFactory)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../LoggerContext.html#newInstance(org.apache.logging.log4j.core.LoggerContext,java.lang.String,org.apache.logging.log4j.message.MessageFactory)">newInstance</a></code> in class <code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setName(java.lang.String)"> |
| <h3>setName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setName</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> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../LoggerContext.html#setName(java.lang.String)">LoggerContext</a></code></span></div> |
| <div class="block">Sets the name.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../LoggerContext.html#setName(java.lang.String)">setName</a></code> in class <code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the new LoggerContext name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="start()"> |
| <h3>start</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../LifeCycle.html#start()">start</a></code> in interface <code><a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../LoggerContext.html#start()">start</a></code> in class <code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="start(org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>start</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../LoggerContext.html#start(org.apache.logging.log4j.core.config.Configuration)">LoggerContext</a></code></span></div> |
| <div class="block">Starts with a specific configuration.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../LoggerContext.html#start(org.apache.logging.log4j.core.config.Configuration)">start</a></code> in class <code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - The new Configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stop(long,java.util.concurrent.TimeUnit)"> |
| <h3>stop</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">stop</span><wbr><span class="parameters">(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../LoggerContext.html#stop(long,java.util.concurrent.TimeUnit)">LoggerContext</a></code></span></div> |
| <div class="block">Blocks until all Log4j tasks have completed execution after a shutdown request and all appenders have shut down, |
| or the timeout occurs, or the current thread is interrupted, whichever happens first. |
| <p> |
| Not all appenders will honor this, it is a hint and not an absolute guarantee that the this method not block longer. |
| Setting timeout too low increase the risk of losing outstanding log events not yet written to the final |
| destination. |
| <p> |
| Log4j can start threads to perform certain actions like file rollovers, calling this method with a positive timeout will |
| block until the rollover thread is done.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../LifeCycle2.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code> in interface <code><a href="../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../LoggerContext.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code> in class <code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>timeout</code> - the maximum time to wait, or 0 which mean that each apppender uses its default timeout, and don't wait for background |
| tasks</dd> |
| <dd><code>timeUnit</code> - the time unit of the timeout argument</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the logger context terminated and <code>false</code> if the timeout elapsed before |
| termination.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRingBufferAdmin()"> |
| <h3>createRingBufferAdmin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../jmx/RingBufferAdmin.html" title="class in org.apache.logging.log4j.core.jmx">RingBufferAdmin</a></span> <span class="element-name">createRingBufferAdmin</span>()</div> |
| <div class="block">Creates and returns a new <code>RingBufferAdmin</code> that instruments the ringbuffer of the <code>AsyncLogger</code> |
| objects in this <code>LoggerContext</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new <code>RingBufferAdmin</code> that instruments the ringbuffer</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUseThreadLocals(boolean)"> |
| <h3>setUseThreadLocals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUseThreadLocals</span><wbr><span class="parameters">(boolean useThreadLocals)</span></div> |
| <div class="block">Signals this context whether it is allowed to use ThreadLocal objects for efficiency.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>useThreadLocals</code> - whether this context is allowed to use ThreadLocal objects</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> |
