| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>LoggerContext (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, class: LoggerContext"> |
| <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/LoggerContext.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><a href="#field-detail">Field</a> | </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</a></div> |
| <h1 title="Class LoggerContext" class="title">Class LoggerContext</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">org.apache.logging.log4j.core.LoggerContext</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> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="async/AsyncLoggerContext.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerContext</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LoggerContext</span> |
| <span class="extends-implements">extends <a href="AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a> |
| implements <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>, <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>, <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>, <a href="config/ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a>, <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></span></div> |
| <div class="block">The LoggerContext is the anchor for the logging system. It maintains a list of all the loggers requested by |
| applications and a reference to the Configuration. The Configuration will contain the configured loggers, appenders, |
| filters, etc and will be atomically updated whenever a reconfigure occurs.</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="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <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"><code><a href="#PROPERTY_CONFIG" class="member-name-link">PROPERTY_CONFIG</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Property name of the property change event fired if the configuration is changed.</div> |
| </div> |
| </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">LoggerContext</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 class="block">Constructor taking only a name.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.Object)" class="member-name-link">LoggerContext</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 class="block">Constructor taking a name and a reference to an external context.</div> |
| </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">LoggerContext</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 class="block">Constructor taking a name external context and a configuration location String.</div> |
| </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">LoggerContext</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 class="block">Constructor taking a name, external context and a configuration URI.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addFilter(org.apache.logging.log4j.core.Filter)" class="member-name-link">addFilter</a><wbr>(<a href="Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a Filter to the Configuration.</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="#addPropertyChangeListener(java.beans.PropertyChangeListener)" class="member-name-link">addPropertyChangeListener</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a> listener)</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="#addShutdownListener(org.apache.logging.log4j.spi.LoggerContextShutdownAware)" class="member-name-link">addShutdownListener</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextShutdownAware.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextShutdownAware</a> listener)</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="#close()" class="member-name-link">close</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><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfigLocation()" class="member-name-link">getConfigLocation</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 initial configuration location 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="config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfiguration()" class="member-name-link">getConfiguration</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 current Configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the current LoggerContext.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getContext(boolean)" class="member-name-link">getContext</a><wbr>(boolean currentContext)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a LoggerContext.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getContext(java.lang.ClassLoader,boolean,java.net.URI)" class="member-name-link">getContext</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a> loader, |
| boolean currentContext, |
| <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> configLocation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a LoggerContext.</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExternalContext()" class="member-name-link">getExternalContext</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 external context.</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextShutdownAware.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextShutdownAware</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getListeners()" class="member-name-link">getListeners</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><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="#getLogger(java.lang.String)" class="member-name-link">getLogger</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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets a Logger from the Context.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Logger.html" title="class in org.apache.logging.log4j.core">Logger</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)" class="member-name-link">getLogger</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://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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a Logger from the Context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerRegistry.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerRegistry</a><<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="#getLoggerRegistry()" class="member-name-link">getLoggerRegistry</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the LoggerRegistry.</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/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="Logger.html" title="class in org.apache.logging.log4j.core">Logger</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLoggers()" class="member-name-link">getLoggers</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets a collection of the current loggers.</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">Gets the name.</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObject(java.lang.String)" class="member-name-link">getObject</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> key)</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><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="#getRootLogger()" class="member-name-link">getRootLogger</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the root logger.</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="#hasLogger(java.lang.String)" class="member-name-link">hasLogger</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">Determines if the specified Logger exists.</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="#hasLogger(java.lang.String,java.lang.Class)" class="member-name-link">hasLogger</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/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <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>> messageFactoryClass)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines if the specified Logger exists.</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="#hasLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)" class="member-name-link">hasLogger</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://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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines if the specified Logger exists.</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="#onChange(org.apache.logging.log4j.core.config.Reconfigurable)" class="member-name-link">onChange</a><wbr>(<a href="config/Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config">Reconfigurable</a> reconfigurable)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Causes a reconfiguration to take place when the underlying configuration file changes.</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#putObject(java.lang.String,java.lang.Object)" class="member-name-link">putObject</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> key, |
| <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> value)</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><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#putObjectIfAbsent(java.lang.String,java.lang.Object)" class="member-name-link">putObjectIfAbsent</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> key, |
| <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> value)</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="#reconfigure()" class="member-name-link">reconfigure</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reconfigures the context.</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="#reconfigure(org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">reconfigure</a><wbr>(<a href="config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</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="#removeFilter(org.apache.logging.log4j.core.Filter)" class="member-name-link">removeFilter</a><wbr>(<a href="Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes a Filter from the current Configuration.</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeObject(java.lang.String)" class="member-name-link">removeObject</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> key)</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="#removeObject(java.lang.String,java.lang.Object)" class="member-name-link">removeObject</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> key, |
| <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> value)</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="#removePropertyChangeListener(java.beans.PropertyChangeListener)" class="member-name-link">removePropertyChangeListener</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a> listener)</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="#setConfigLocation(java.net.URI)" class="member-name-link">setConfigLocation</a><wbr>(<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> configLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the configLocation to the specified value and reconfigures this context.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConfiguration(org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">setConfiguration</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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the Configuration to be used.</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="#setExternalContext(java.lang.Object)" class="member-name-link">setExternalContext</a><wbr>(<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> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the external context.</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="#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="#start()" class="member-name-link">start</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>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(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 even-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 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="#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 odd-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 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="#terminate()" class="member-name-link">terminate</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="#updateLoggers()" class="member-name-link">updateLoggers</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Causes all Loggers to be updated against the current Configuration.</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="#updateLoggers(org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">updateLoggers</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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Causes all Logger to be updated against the specified Configuration.</div> |
| </div> |
| </div> |
| </div> |
| </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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="PROPERTY_CONFIG"> |
| <h3>PROPERTY_CONFIG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">PROPERTY_CONFIG</span></div> |
| <div class="block">Property name of the property change event fired if the configuration is changed.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.logging.log4j.core.LoggerContext.PROPERTY_CONFIG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= 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>LoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LoggerContext</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">Constructor taking only a name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The context name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.Object)"> |
| <h3>LoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LoggerContext</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> |
| <div class="block">Constructor taking a name and a reference to an external context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The context name.</dd> |
| <dd><code>externalContext</code> - The external context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.Object,java.net.URI)"> |
| <h3>LoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LoggerContext</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> |
| <div class="block">Constructor taking a name, external context and a configuration URI.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The context name.</dd> |
| <dd><code>externalContext</code> - The external context.</dd> |
| <dd><code>configLocn</code> - The location of the configuration as a URI.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.Object,java.lang.String)"> |
| <h3>LoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LoggerContext</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> |
| <div class="block">Constructor taking a name external context and a configuration location String. The location must be resolvable |
| to a File.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The configuration location.</dd> |
| <dd><code>externalContext</code> - The external context.</dd> |
| <dd><code>configLocn</code> - The configuration location.</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="addShutdownListener(org.apache.logging.log4j.spi.LoggerContextShutdownAware)"> |
| <h3>addShutdownListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addShutdownListener</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextShutdownAware.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextShutdownAware</a> listener)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextShutdownEnabled.html#addShutdownListener(org.apache.logging.log4j.spi.LoggerContextShutdownAware)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">addShutdownListener</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getListeners()"> |
| <h3>getListeners</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextShutdownAware.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextShutdownAware</a>></span> <span class="element-name">getListeners</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextShutdownEnabled.html#getListeners()" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getListeners</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext()"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span> <span class="element-name">getContext</span>()</div> |
| <div class="block">Returns the current LoggerContext. |
| <p> |
| Avoids the type cast for: |
| </p> |
| |
| <pre> |
| (LoggerContext) LogManager.getContext(); |
| </pre> |
| |
| <p> |
| WARNING - The LoggerContext returned by this method may not be the LoggerContext used to create a Logger for the |
| calling class. |
| </p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The current LoggerContext.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/LogManager.html#getContext()" title="class or interface in org.apache.logging.log4j" class="external-link"><code>LogManager.getContext()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(boolean)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span> <span class="element-name">getContext</span><wbr><span class="parameters">(boolean currentContext)</span></div> |
| <div class="block">Returns a LoggerContext. |
| <p> |
| Avoids the type cast for: |
| </p> |
| |
| <pre> |
| (LoggerContext) LogManager.getContext(currentContext); |
| </pre></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>currentContext</code> - if false the LoggerContext appropriate for the caller of this method is returned. For |
| example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be |
| returned and if the caller is a class in the container's classpath then a different LoggerContext may |
| be returned. If true then only a single LoggerContext will be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>a LoggerContext.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/LogManager.html#getContext(boolean)" title="class or interface in org.apache.logging.log4j" class="external-link"><code>LogManager.getContext(boolean)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(java.lang.ClassLoader,boolean,java.net.URI)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span> <span class="element-name">getContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a> loader, |
| boolean currentContext, |
| <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> configLocation)</span></div> |
| <div class="block">Returns a LoggerContext. |
| <p> |
| Avoids the type cast for: |
| </p> |
| |
| <pre> |
| (LoggerContext) LogManager.getContext(loader, currentContext, configLocation); |
| </pre></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - The ClassLoader for the context. If null the context will attempt to determine the appropriate |
| ClassLoader.</dd> |
| <dd><code>currentContext</code> - if false the LoggerContext appropriate for the caller of this method is returned. For |
| example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be |
| returned and if the caller is a class in the container's classpath then a different LoggerContext may |
| be returned. If true then only a single LoggerContext will be returned.</dd> |
| <dd><code>configLocation</code> - The URI for the configuration to use.</dd> |
| <dt>Returns:</dt> |
| <dd>a LoggerContext.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/LogManager.html#getContext(java.lang.ClassLoader,boolean,java.net.URI)" title="class or interface in org.apache.logging.log4j" class="external-link"><code>LogManager.getContext(ClassLoader, boolean, URI)</code></a></li> |
| </ul> |
| </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="AbstractLifeCycle.html#start()">start</a></code> in class <code><a href="AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</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">Starts with a specific configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - The new Configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html#close--" title="class or interface in java.lang" class="external-link">close</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="terminate()"> |
| <h3>terminate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">terminate</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/Terminable.html#terminate()" title="class or interface in org.apache.logging.log4j.spi" class="external-link">terminate</a></code> in interface <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> |
| </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">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="AbstractLifeCycle.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code> in class <code><a href="AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</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> |
| <dt>Since:</dt> |
| <dd>2.7</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">Gets the name.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRootLogger()"> |
| <h3>getRootLogger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Logger.html" title="class in org.apache.logging.log4j.core">Logger</a></span> <span class="element-name">getRootLogger</span>()</div> |
| <div class="block">Gets the root logger.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the root logger.</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">Sets the name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the new LoggerContext name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the specified name is <code>null</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObject(java.lang.String)"> |
| <h3>getObject</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getObject</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> key)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#getObject(java.lang.String)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getObject</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putObject(java.lang.String,java.lang.Object)"> |
| <h3>putObject</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">putObject</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> key, |
| <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> value)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#putObject(java.lang.String,java.lang.Object)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">putObject</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putObjectIfAbsent(java.lang.String,java.lang.Object)"> |
| <h3>putObjectIfAbsent</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">putObjectIfAbsent</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> key, |
| <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> value)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#putObjectIfAbsent(java.lang.String,java.lang.Object)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">putObjectIfAbsent</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeObject(java.lang.String)"> |
| <h3>removeObject</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">removeObject</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> key)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#removeObject(java.lang.String)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">removeObject</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeObject(java.lang.String,java.lang.Object)"> |
| <h3>removeObject</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeObject</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> key, |
| <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> value)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#removeObject(java.lang.String,java.lang.Object)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">removeObject</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setExternalContext(java.lang.Object)"> |
| <h3>setExternalContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setExternalContext</span><wbr><span class="parameters">(<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> context)</span></div> |
| <div class="block">Sets the external context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The external context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExternalContext()"> |
| <h3>getExternalContext</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getExternalContext</span>()</div> |
| <div class="block">Returns the external context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#getExternalContext()" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getExternalContext</a></code> in interface <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></dd> |
| <dt>Returns:</dt> |
| <dd>The external context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLogger(java.lang.String)"> |
| <h3>getLogger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Logger.html" title="class in org.apache.logging.log4j.core">Logger</a></span> <span class="element-name">getLogger</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">Gets a Logger from the Context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#getLogger(java.lang.String)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getLogger</a></code> in interface <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></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger to return.</dd> |
| <dt>Returns:</dt> |
| <dd>The Logger.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLoggers()"> |
| <h3>getLoggers</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/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="Logger.html" title="class in org.apache.logging.log4j.core">Logger</a>></span> <span class="element-name">getLoggers</span>()</div> |
| <div class="block">Gets a collection of the current loggers. |
| <p> |
| Whether this collection is a copy of the underlying collection or not is undefined. Therefore, modify this |
| collection at your own risk. |
| </p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a collection of the current loggers.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)"> |
| <h3>getLogger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Logger.html" title="class in org.apache.logging.log4j.core">Logger</a></span> <span class="element-name">getLogger</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://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> |
| <div class="block">Obtains a Logger from the Context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#getLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getLogger</a></code> in interface <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></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger to return.</dd> |
| <dd><code>messageFactory</code> - The message factory is used only when creating a logger, subsequent use does not change the |
| logger but will log a warning if mismatched.</dd> |
| <dt>Returns:</dt> |
| <dd>The Logger.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLoggerRegistry()"> |
| <h3>getLoggerRegistry</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerRegistry.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerRegistry</a><<a href="Logger.html" title="class in org.apache.logging.log4j.core">Logger</a>></span> <span class="element-name">getLoggerRegistry</span>()</div> |
| <div class="block">Gets the LoggerRegistry.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#getLoggerRegistry()" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getLoggerRegistry</a></code> in interface <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></dd> |
| <dt>Returns:</dt> |
| <dd>the LoggerRegistry.</dd> |
| <dt>Since:</dt> |
| <dd>2.17.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasLogger(java.lang.String)"> |
| <h3>hasLogger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasLogger</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">Determines if the specified Logger exists.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#hasLogger(java.lang.String)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">hasLogger</a></code> in interface <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></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The Logger name to search for.</dd> |
| <dt>Returns:</dt> |
| <dd>True if the Logger exists, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)"> |
| <h3>hasLogger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasLogger</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://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> |
| <div class="block">Determines if the specified Logger exists.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#hasLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">hasLogger</a></code> in interface <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></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The Logger name to search for.</dd> |
| <dt>Returns:</dt> |
| <dd>True if the Logger exists, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasLogger(java.lang.String,java.lang.Class)"> |
| <h3>hasLogger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasLogger</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/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <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>> messageFactoryClass)</span></div> |
| <div class="block">Determines if the specified Logger exists.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html#hasLogger(java.lang.String,java.lang.Class)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">hasLogger</a></code> in interface <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></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The Logger name to search for.</dd> |
| <dt>Returns:</dt> |
| <dd>True if the Logger exists, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConfiguration()"> |
| <h3>getConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></span> <span class="element-name">getConfiguration</span>()</div> |
| <div class="block">Returns the current Configuration. The Configuration will be replaced when a reconfigure occurs.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The current Configuration, never <code>null</code>, but may be |
| <a href="config/NullConfiguration.html" title="class in org.apache.logging.log4j.core.config"><code>NullConfiguration</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addFilter(org.apache.logging.log4j.core.Filter)"> |
| <h3>addFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addFilter</span><wbr><span class="parameters">(<a href="Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="block">Adds a Filter to the Configuration. Filters that are added through the API will be lost when a reconfigure |
| occurs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - The Filter to add.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeFilter(org.apache.logging.log4j.core.Filter)"> |
| <h3>removeFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeFilter</span><wbr><span class="parameters">(<a href="Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="block">Removes a Filter from the current Configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - The Filter to remove.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConfiguration(org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>setConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></span> <span class="element-name">setConfiguration</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">Sets the Configuration to be used.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - The new Configuration.</dd> |
| <dt>Returns:</dt> |
| <dd>The previous Configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addPropertyChangeListener(java.beans.PropertyChangeListener)"> |
| <h3>addPropertyChangeListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addPropertyChangeListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a> listener)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removePropertyChangeListener(java.beans.PropertyChangeListener)"> |
| <h3>removePropertyChangeListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removePropertyChangeListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a> listener)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConfigLocation()"> |
| <h3>getConfigLocation</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/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span> <span class="element-name">getConfigLocation</span>()</div> |
| <div class="block">Returns the initial configuration location or <code>null</code>. The returned value may not be the location of the |
| current configuration. Use <a href="#getConfiguration()"><code>getConfiguration()</code></a>.<a href="config/Configuration.html#getConfigurationSource()"><code>getConfigurationSource()</code></a>.<a href="config/ConfigurationSource.html#getLocation()"><code>getLocation()</code></a> to get the actual source of the |
| current configuration.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the initial configuration location or <code>null</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConfigLocation(java.net.URI)"> |
| <h3>setConfigLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setConfigLocation</span><wbr><span class="parameters">(<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> configLocation)</span></div> |
| <div class="block">Sets the configLocation to the specified value and reconfigures this context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>configLocation</code> - the location of the new configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconfigure()"> |
| <h3>reconfigure</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reconfigure</span>()</div> |
| <div class="block">Reconfigures the context. Log4j does not remove Loggers during a reconfiguration. Log4j will create new |
| LoggerConfig objects and Log4j will point the Loggers at the new LoggerConfigs. Log4j will free the old |
| LoggerConfig, along with old Appenders and Filters.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconfigure(org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>reconfigure</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reconfigure</span><wbr><span class="parameters">(<a href="config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateLoggers()"> |
| <h3>updateLoggers</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateLoggers</span>()</div> |
| <div class="block">Causes all Loggers to be updated against the current Configuration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateLoggers(org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>updateLoggers</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateLoggers</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">Causes all Logger to be updated against the specified Configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - The Configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onChange(org.apache.logging.log4j.core.config.Reconfigurable)"> |
| <h3>onChange</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onChange</span><wbr><span class="parameters">(<a href="config/Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config">Reconfigurable</a> reconfigurable)</span></div> |
| <div class="block">Causes a reconfiguration to take place when the underlying configuration file changes.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="config/ConfigurationListener.html#onChange(org.apache.logging.log4j.core.config.Reconfigurable)">onChange</a></code> in interface <code><a href="config/ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>reconfigurable</code> - The Configuration that can be reconfigured.</dd> |
| </dl> |
| </section> |
| </li> |
| <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> |
| </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> |