| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractConfiguration (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.config, class: AbstractConfiguration"> |
| <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/AbstractConfiguration.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.config</a></div> |
| <h1 title="Class AbstractConfiguration" class="title">Class AbstractConfiguration</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.AbstractLifeCycle</a> |
| <div class="inheritance"><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.AbstractFilterable</a> |
| <div class="inheritance">org.apache.logging.log4j.core.config.AbstractConfiguration</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code>, <code><a href="../filter/Filterable.html" title="interface in org.apache.logging.log4j.core.filter">Filterable</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></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="builder/impl/BuiltConfiguration.html" title="class in org.apache.logging.log4j.core.config.builder.impl">BuiltConfiguration</a></code>, <code><a href="composite/CompositeConfiguration.html" title="class in org.apache.logging.log4j.core.config.composite">CompositeConfiguration</a></code>, <code><a href="DefaultConfiguration.html" title="class in org.apache.logging.log4j.core.config">DefaultConfiguration</a></code>, <code><a href="json/JsonConfiguration.html" title="class in org.apache.logging.log4j.core.config.json">JsonConfiguration</a></code>, <code><a href="NullConfiguration.html" title="class in org.apache.logging.log4j.core.config">NullConfiguration</a></code>, <code><a href="xml/XmlConfiguration.html" title="class in org.apache.logging.log4j.core.config.xml">XmlConfiguration</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractConfiguration</span> |
| <span class="extends-implements">extends <a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a> |
| implements <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></span></div> |
| <div class="block">The base Configuration. Many configuration implementations will extend this class.</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.filter.AbstractFilterable">Nested classes/interfaces inherited from class org.apache.logging.log4j.core.filter.<a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></h2> |
| <code><a href="../filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable.Builder</a><<a href="../filter/AbstractFilterable.Builder.html" title="type parameter in AbstractFilterable.Builder">B</a> extends <a href="../filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable.Builder</a><<a href="../filter/AbstractFilterable.Builder.html" title="type parameter in AbstractFilterable.Builder">B</a>>></code></div> |
| <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>protected boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#isShutdownHookEnabled" class="member-name-link">isShutdownHookEnabled</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Shutdown hook is enabled by default.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final <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="ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#listeners" class="member-name-link">listeners</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Listeners for configuration changes.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected <a href="plugins/util/PluginManager.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginManager</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#pluginManager" class="member-name-link">pluginManager</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The plugin manager.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final <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://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"><code><a href="#pluginPackages" class="member-name-link">pluginPackages</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Packages found in configuration "packages" attribute.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected <a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#rootNode" class="member-name-link">rootNode</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The root node of the configuration.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../script/ScriptManager.html" title="class in org.apache.logging.log4j.core.script">ScriptManager</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#scriptManager" class="member-name-link">scriptManager</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The Script manager.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected long</code></div> |
| <div class="col-second even-row-color"><code><a href="#shutdownTimeoutMillis" class="member-name-link">shutdownTimeoutMillis</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Shutdown timeout in milliseconds.</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.core.config.Configuration">Fields inherited from interface org.apache.logging.log4j.core.config.<a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></h3> |
| <code><a href="Configuration.html#CONTEXT_PROPERTIES">CONTEXT_PROPERTIES</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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.LoggerContext,org.apache.logging.log4j.core.config.ConfigurationSource)" class="member-name-link">AbstractConfiguration</a><wbr>(<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> configurationSource)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructor.</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="#addAppender(org.apache.logging.log4j.core.Appender)" class="member-name-link">addAppender</a><wbr>(<a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a> appender)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds an Appender 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="#addComponent(java.lang.String,java.lang.Object)" class="member-name-link">addComponent</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> componentName, |
| <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> obj)</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="#addListener(org.apache.logging.log4j.core.config.ConfigurationListener)" class="member-name-link">addListener</a><wbr>(<a href="ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a listener for changes on 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="#addLogger(java.lang.String,org.apache.logging.log4j.core.config.LoggerConfig)" class="member-name-link">addLogger</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> loggerName, |
| <a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a> loggerConfig)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a loggerConfig.</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="#addLoggerAppender(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.core.Appender)" class="member-name-link">addLoggerAppender</a><wbr>(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a> appender)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Associates an Appender with a LoggerConfig.</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="#addLoggerFilter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.core.Filter)" class="member-name-link">addLoggerFilter</a><wbr>(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <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">Associates a Filter with a LoggerConfig.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createAdvertiser(java.lang.String,org.apache.logging.log4j.core.config.ConfigurationSource,byte%5B%5D,java.lang.String)" class="member-name-link">createAdvertiser</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> advertiserString, |
| <a href="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> configSource, |
| byte[] buffer, |
| <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> contentType)</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="#createConfiguration(org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.LogEvent)" class="member-name-link">createConfiguration</a><wbr>(<a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> node, |
| <a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</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="#createPluginObject(org.apache.logging.log4j.core.config.plugins.util.PluginType,org.apache.logging.log4j.core.config.Node)" class="member-name-link">createPluginObject</a><wbr>(<a href="plugins/util/PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a><?> type, |
| <a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> node)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method is used by Arbiters to create specific children.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doConfigure()" class="member-name-link">doConfigure</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="../net/Advertiser.html" title="interface in org.apache.logging.log4j.core.net">Advertiser</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAdvertiser()" class="member-name-link">getAdvertiser</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><T extends <a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>><br>T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAppender(java.lang.String)" class="member-name-link">getAppender</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> appenderName)</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 Appender with the specified 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/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAppenders()" class="member-name-link">getAppenders</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a Map containing all the Appenders and their name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAsyncLoggerConfigDelegate()" class="member-name-link">getAsyncLoggerConfigDelegate</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 <code>AsyncLoggerConfigDelegate</code> shared by all |
| <code>AsyncLoggerConfig</code> instances defined in this Configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../async/AsyncWaitStrategyFactory.html" title="interface in org.apache.logging.log4j.core.async">AsyncWaitStrategyFactory</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAsyncWaitStrategyFactory()" class="member-name-link">getAsyncWaitStrategyFactory</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the <code>AsyncWaitStrategyFactory</code> defined in this Configuration; |
| this factory is used to create the LMAX disruptor <code>WaitStrategy</code> used |
| by the disruptor ringbuffer for Async Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComponent(java.lang.String)" class="member-name-link">getComponent</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> componentName)</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="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfigurationSource()" class="member-name-link">getConfigurationSource</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 source of this configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfigurationStrSubstitutor()" class="member-name-link">getConfigurationStrSubstitutor</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="CustomLevelConfig.html" title="class in org.apache.logging.log4j.core.config">CustomLevelConfig</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCustomLevels()" class="member-name-link">getCustomLevels</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block"> |
| Returns a list of descriptors of the custom levels defined in the current configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDefaultLevel()" class="member-name-link">getDefaultLevel</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultStatus()" class="member-name-link">getDefaultStatus</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="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</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> loggerName)</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 LoggerConfig with the specified name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLoggerConfig(java.lang.String)" class="member-name-link">getLoggerConfig</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> loggerName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Locates the appropriate LoggerConfig for a Logger name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#getLoggerContext()" class="member-name-link">getLoggerContext</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 logger 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/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</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">Returns a Map of all the LoggerConfigs.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name of the configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util">NanoClock</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNanoClock()" class="member-name-link">getNanoClock</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 <a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util"><code>NanoClock</code></a> instance for this configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="plugins/util/PluginManager.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginManager</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPluginManager()" class="member-name-link">getPluginManager</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPluginPackages()" class="member-name-link">getPluginPackages</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 list of packages to scan for plugins for this Configuration.</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/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProperties()" class="member-name-link">getProperties</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="ReliabilityStrategy.html" title="interface in org.apache.logging.log4j.core.config">ReliabilityStrategy</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReliabilityStrategy(org.apache.logging.log4j.core.config.LoggerConfig)" class="member-name-link">getReliabilityStrategy</a><wbr>(<a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a> loggerConfig)</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="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</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">Returns the root Logger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRootNode()" class="member-name-link">getRootNode</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="ConfigurationScheduler.html" title="class in org.apache.logging.log4j.core.config">ConfigurationScheduler</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheduler()" class="member-name-link">getScheduler</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="../script/ScriptManager.html" title="class in org.apache.logging.log4j.core.script">ScriptManager</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScriptManager()" class="member-name-link">getScriptManager</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>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getShutdownTimeoutMillis()" class="member-name-link">getShutdownTimeoutMillis</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="../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStrSubstitutor()" class="member-name-link">getStrSubstitutor</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="../util/WatchManager.html" title="class in org.apache.logging.log4j.core.util">WatchManager</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWatchManager()" class="member-name-link">getWatchManager</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the WatchManager.</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="#initialize()" class="member-name-link">initialize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Initialize the configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initializeWatchers(org.apache.logging.log4j.core.config.Reconfigurable,org.apache.logging.log4j.core.config.ConfigurationSource,int)" class="member-name-link">initializeWatchers</a><wbr>(<a href="Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config">Reconfigurable</a> reconfigurable, |
| <a href="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> configSource, |
| int monitorIntervalSeconds)</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isShutdownHookEnabled()" class="member-name-link">isShutdownHookEnabled</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>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#preConfigure(org.apache.logging.log4j.core.config.Node)" class="member-name-link">preConfigure</a><wbr>(<a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> node)</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>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#processConditionals(org.apache.logging.log4j.core.config.Node)" class="member-name-link">processConditionals</a><wbr>(<a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> node)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Process conditions by evaluating them and including the children of conditions that are true |
| and discarding those that are not.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#processSelect(org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.config.plugins.util.PluginType)" class="member-name-link">processSelect</a><wbr>(<a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> selectNode, |
| <a href="plugins/util/PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a><?> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Handle Select nodes.</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="#removeAppender(java.lang.String)" class="member-name-link">removeAppender</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> appenderName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove an Appender.</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="#removeListener(org.apache.logging.log4j.core.config.ConfigurationListener)" class="member-name-link">removeListener</a><wbr>(<a href="ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a> listener)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove a ConfigurationListener.</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="#removeLogger(java.lang.String)" class="member-name-link">removeLogger</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> loggerName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove a LoggerConfig.</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="#setAdvertiser(org.apache.logging.log4j.core.net.Advertiser)" class="member-name-link">setAdvertiser</a><wbr>(<a href="../net/Advertiser.html" title="interface in org.apache.logging.log4j.core.net">Advertiser</a> advertiser)</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="#setLoggerAdditive(org.apache.logging.log4j.core.Logger,boolean)" class="member-name-link">setLoggerAdditive</a><wbr>(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| boolean additive)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Marks a LoggerConfig as additive.</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="#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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the name of the 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="#setNanoClock(org.apache.logging.log4j.core.util.NanoClock)" class="member-name-link">setNanoClock</a><wbr>(<a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util">NanoClock</a> nanoClock)</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 <a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util"><code>NanoClock</code></a> instance for this 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="#setPluginManager(org.apache.logging.log4j.core.config.plugins.util.PluginManager)" class="member-name-link">setPluginManager</a><wbr>(<a href="plugins/util/PluginManager.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginManager</a> pluginManager)</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="#setScriptManager(org.apache.logging.log4j.core.script.ScriptManager)" class="member-name-link">setScriptManager</a><wbr>(<a href="../script/ScriptManager.html" title="class in org.apache.logging.log4j.core.script">ScriptManager</a> scriptManager)</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>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setToDefault()" class="member-name-link">setToDefault</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="#setup()" class="member-name-link">setup</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" 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 class="block">Start the configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop(long,java.util.concurrent.TimeUnit)" class="member-name-link">stop</a><wbr>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tear down the configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toByteArray(java.io.InputStream)" class="member-name-link">toByteArray</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> is)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Reads an InputStream using buffered reads into a byte array buffer.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.filter.AbstractFilterable">Methods inherited from class org.apache.logging.log4j.core.filter.<a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></h3> |
| <code><a href="../filter/AbstractFilterable.html#addFilter(org.apache.logging.log4j.core.Filter)">addFilter</a>, <a href="../filter/AbstractFilterable.html#getFilter()">getFilter</a>, <a href="../filter/AbstractFilterable.html#getPropertyArray()">getPropertyArray</a>, <a href="../filter/AbstractFilterable.html#hasFilter()">hasFilter</a>, <a href="../filter/AbstractFilterable.html#isFiltered(org.apache.logging.log4j.core.LogEvent)">isFiltered</a>, <a href="../filter/AbstractFilterable.html#removeFilter(org.apache.logging.log4j.core.Filter)">removeFilter</a>, <a href="../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit,boolean)">stop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Methods inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#equalsImpl(java.lang.Object)">equalsImpl</a>, <a href="../AbstractLifeCycle.html#getState()">getState</a>, <a href="../AbstractLifeCycle.html#getStatusLogger()">getStatusLogger</a>, <a href="../AbstractLifeCycle.html#hashCodeImpl()">hashCodeImpl</a>, <a href="../AbstractLifeCycle.html#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.core.filter.Filterable">Methods inherited from interface org.apache.logging.log4j.core.filter.<a href="../filter/Filterable.html" title="interface in org.apache.logging.log4j.core.filter">Filterable</a></h3> |
| <code><a href="../filter/Filterable.html#addFilter(org.apache.logging.log4j.core.Filter)">addFilter</a>, <a href="../filter/Filterable.html#getFilter()">getFilter</a>, <a href="../filter/Filterable.html#hasFilter()">hasFilter</a>, <a href="../filter/Filterable.html#isFiltered(org.apache.logging.log4j.core.LogEvent)">isFiltered</a>, <a href="../filter/Filterable.html#removeFilter(org.apache.logging.log4j.core.Filter)">removeFilter</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Methods inherited from interface org.apache.logging.log4j.core.<a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h3> |
| <code><a href="../LifeCycle.html#getState()">getState</a>, <a href="../LifeCycle.html#isStarted()">isStarted</a>, <a href="../LifeCycle.html#isStopped()">isStopped</a>, <a href="../LifeCycle.html#stop()">stop</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="rootNode"> |
| <h3>rootNode</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a></span> <span class="element-name">rootNode</span></div> |
| <div class="block">The root node of the configuration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="listeners"> |
| <h3>listeners</h3> |
| <div class="member-signature"><span class="modifiers">protected final</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="ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a>></span> <span class="element-name">listeners</span></div> |
| <div class="block">Listeners for configuration changes.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="pluginPackages"> |
| <h3>pluginPackages</h3> |
| <div class="member-signature"><span class="modifiers">protected final</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://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">pluginPackages</span></div> |
| <div class="block">Packages found in configuration "packages" attribute.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="pluginManager"> |
| <h3>pluginManager</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="plugins/util/PluginManager.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginManager</a></span> <span class="element-name">pluginManager</span></div> |
| <div class="block">The plugin manager.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isShutdownHookEnabled"> |
| <h3>isShutdownHookEnabled</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isShutdownHookEnabled</span></div> |
| <div class="block">Shutdown hook is enabled by default.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdownTimeoutMillis"> |
| <h3>shutdownTimeoutMillis</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name">shutdownTimeoutMillis</span></div> |
| <div class="block">Shutdown timeout in milliseconds.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scriptManager"> |
| <h3>scriptManager</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../script/ScriptManager.html" title="class in org.apache.logging.log4j.core.script">ScriptManager</a></span> <span class="element-name">scriptManager</span></div> |
| <div class="block">The Script manager.</div> |
| </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>(org.apache.logging.log4j.core.LoggerContext,org.apache.logging.log4j.core.config.ConfigurationSource)"> |
| <h3>AbstractConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractConfiguration</span><wbr><span class="parameters">(<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> configurationSource)</span></div> |
| <div class="block">Constructor.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getConfigurationSource()"> |
| <h3>getConfigurationSource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></span> <span class="element-name">getConfigurationSource</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#getConfigurationSource()">Configuration</a></code></span></div> |
| <div class="block">Returns the source of this configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getConfigurationSource()">getConfigurationSource</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the source of this configuration, never <code>null</code>, but may be |
| <a href="ConfigurationSource.html#NULL_SOURCE"><code>ConfigurationSource.NULL_SOURCE</code></a> |
| or |
| <a href="ConfigurationSource.html#COMPOSITE_SOURCE"><code>ConfigurationSource.COMPOSITE_SOURCE</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPluginPackages()"> |
| <h3>getPluginPackages</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://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">getPluginPackages</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#getPluginPackages()">Configuration</a></code></span></div> |
| <div class="block">Returns the list of packages to scan for plugins for this Configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getPluginPackages()">getPluginPackages</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the list of plugin packages.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProperties()"> |
| <h3>getProperties</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/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<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>></span> <span class="element-name">getProperties</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getProperties()">getProperties</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScriptManager()"> |
| <h3>getScriptManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../script/ScriptManager.html" title="class in org.apache.logging.log4j.core.script">ScriptManager</a></span> <span class="element-name">getScriptManager</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getScriptManager()">getScriptManager</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setScriptManager(org.apache.logging.log4j.core.script.ScriptManager)"> |
| <h3>setScriptManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setScriptManager</span><wbr><span class="parameters">(<a href="../script/ScriptManager.html" title="class in org.apache.logging.log4j.core.script">ScriptManager</a> scriptManager)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPluginManager()"> |
| <h3>getPluginManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="plugins/util/PluginManager.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginManager</a></span> <span class="element-name">getPluginManager</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPluginManager(org.apache.logging.log4j.core.config.plugins.util.PluginManager)"> |
| <h3>setPluginManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPluginManager</span><wbr><span class="parameters">(<a href="plugins/util/PluginManager.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginManager</a> pluginManager)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWatchManager()"> |
| <h3>getWatchManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../util/WatchManager.html" title="class in org.apache.logging.log4j.core.util">WatchManager</a></span> <span class="element-name">getWatchManager</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#getWatchManager()">Configuration</a></code></span></div> |
| <div class="block">Return the WatchManager.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getWatchManager()">getWatchManager</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the WatchManager.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScheduler()"> |
| <h3>getScheduler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigurationScheduler.html" title="class in org.apache.logging.log4j.core.config">ConfigurationScheduler</a></span> <span class="element-name">getScheduler</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getScheduler()">getScheduler</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRootNode()"> |
| <h3>getRootNode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a></span> <span class="element-name">getRootNode</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAsyncLoggerConfigDelegate()"> |
| <h3>getAsyncLoggerConfigDelegate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></span> <span class="element-name">getAsyncLoggerConfigDelegate</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#getAsyncLoggerConfigDelegate()">Configuration</a></code></span></div> |
| <div class="block">Returns the <code>AsyncLoggerConfigDelegate</code> shared by all |
| <code>AsyncLoggerConfig</code> instances defined in this Configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getAsyncLoggerConfigDelegate()">getAsyncLoggerConfigDelegate</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <code>AsyncLoggerConfigDelegate</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAsyncWaitStrategyFactory()"> |
| <h3>getAsyncWaitStrategyFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../async/AsyncWaitStrategyFactory.html" title="interface in org.apache.logging.log4j.core.async">AsyncWaitStrategyFactory</a></span> <span class="element-name">getAsyncWaitStrategyFactory</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#getAsyncWaitStrategyFactory()">Configuration</a></code></span></div> |
| <div class="block">Returns the <code>AsyncWaitStrategyFactory</code> defined in this Configuration; |
| this factory is used to create the LMAX disruptor <code>WaitStrategy</code> used |
| by the disruptor ringbuffer for Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getAsyncWaitStrategyFactory()">getAsyncWaitStrategyFactory</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <code>AsyncWaitStrategyFactory</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initialize()"> |
| <h3>initialize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span>()</div> |
| <div class="block">Initialize the configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../LifeCycle.html#initialize()">initialize</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#initialize()">initialize</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="initializeWatchers(org.apache.logging.log4j.core.config.Reconfigurable,org.apache.logging.log4j.core.config.ConfigurationSource,int)"> |
| <h3>initializeWatchers</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">initializeWatchers</span><wbr><span class="parameters">(<a href="Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config">Reconfigurable</a> reconfigurable, |
| <a href="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> configSource, |
| int monitorIntervalSeconds)</span></div> |
| </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> |
| <div class="block">Start the configuration.</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="../filter/AbstractFilterable.html#start()">start</a></code> in class <code><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</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">Tear down the configuration.</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="../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code> in class <code><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>timeout</code> - the maximum time to wait</dd> |
| <dd><code>timeUnit</code> - the time unit of the timeout argument</dd> |
| <dt>Returns:</dt> |
| <dd>true if the receiver was stopped cleanly and normally, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isShutdownHookEnabled()"> |
| <h3>isShutdownHookEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isShutdownHookEnabled</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#isShutdownHookEnabled()">isShutdownHookEnabled</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getShutdownTimeoutMillis()"> |
| <h3>getShutdownTimeoutMillis</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getShutdownTimeoutMillis</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getShutdownTimeoutMillis()">getShutdownTimeoutMillis</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setup()"> |
| <h3>setup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setup</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDefaultStatus()"> |
| <h3>getDefaultStatus</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a></span> <span class="element-name">getDefaultStatus</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createAdvertiser(java.lang.String,org.apache.logging.log4j.core.config.ConfigurationSource,byte[],java.lang.String)"> |
| <h3>createAdvertiser</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">createAdvertiser</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> advertiserString, |
| <a href="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> configSource, |
| byte[] buffer, |
| <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> contentType)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComponent(java.lang.String)"> |
| <h3>getComponent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getComponent</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> componentName)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getComponent(java.lang.String)">getComponent</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addComponent(java.lang.String,java.lang.Object)"> |
| <h3>addComponent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addComponent</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> componentName, |
| <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> obj)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#addComponent(java.lang.String,java.lang.Object)">addComponent</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="preConfigure(org.apache.logging.log4j.core.config.Node)"> |
| <h3>preConfigure</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">preConfigure</span><wbr><span class="parameters">(<a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> node)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="processConditionals(org.apache.logging.log4j.core.config.Node)"> |
| <h3>processConditionals</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">processConditionals</span><wbr><span class="parameters">(<a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> node)</span></div> |
| <div class="block">Process conditions by evaluating them and including the children of conditions that are true |
| and discarding those that are not.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>node</code> - The node to evaluate.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="processSelect(org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.config.plugins.util.PluginType)"> |
| <h3>processSelect</h3> |
| <div class="member-signature"><span class="modifiers">protected</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="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a>></span> <span class="element-name">processSelect</span><wbr><span class="parameters">(<a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> selectNode, |
| <a href="plugins/util/PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a><?> type)</span></div> |
| <div class="block">Handle Select nodes. This finds the first child condition that returns true and attaches its children |
| to the parent of the Select Node. Other Nodes are discarded.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>selectNode</code> - The Select Node.</dd> |
| <dd><code>type</code> - The PluginType of the Select Node.</dd> |
| <dt>Returns:</dt> |
| <dd>The list of Nodes to be added to the parent.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doConfigure()"> |
| <h3>doConfigure</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doConfigure</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDefaultLevel()"> |
| <h3>getDefaultLevel</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a></span> <span class="element-name">getDefaultLevel</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setToDefault()"> |
| <h3>setToDefault</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">setToDefault</span>()</div> |
| </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">Set the name of the configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name.</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">Returns the name of the configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getName()">getName</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the name of the configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addListener(org.apache.logging.log4j.core.config.ConfigurationListener)"> |
| <h3>addListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addListener</span><wbr><span class="parameters">(<a href="ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a> listener)</span></div> |
| <div class="block">Add a listener for changes on the configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#addListener(org.apache.logging.log4j.core.config.ConfigurationListener)">addListener</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>listener</code> - The ConfigurationListener to add.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeListener(org.apache.logging.log4j.core.config.ConfigurationListener)"> |
| <h3>removeListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeListener</span><wbr><span class="parameters">(<a href="ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a> listener)</span></div> |
| <div class="block">Remove a ConfigurationListener.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#removeListener(org.apache.logging.log4j.core.config.ConfigurationListener)">removeListener</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>listener</code> - The ConfigurationListener to remove.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAppender(java.lang.String)"> |
| <h3>getAppender</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>></span> <span class="return-type">T</span> <span class="element-name">getAppender</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> appenderName)</span></div> |
| <div class="block">Returns the Appender with the specified name.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getAppender(java.lang.String)">getAppender</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - The expected Appender type.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>appenderName</code> - The name of the Appender.</dd> |
| <dt>Returns:</dt> |
| <dd>the Appender with the specified name or null if the Appender cannot be located.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAppenders()"> |
| <h3>getAppenders</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/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>></span> <span class="element-name">getAppenders</span>()</div> |
| <div class="block">Returns a Map containing all the Appenders and their name.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getAppenders()">getAppenders</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>A Map containing each Appender's name and the Appender object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAppender(org.apache.logging.log4j.core.Appender)"> |
| <h3>addAppender</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addAppender</span><wbr><span class="parameters">(<a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a> appender)</span></div> |
| <div class="block">Adds an Appender to the configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#addAppender(org.apache.logging.log4j.core.Appender)">addAppender</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>appender</code> - The Appender to add.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStrSubstitutor()"> |
| <h3>getStrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">getStrSubstitutor</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getStrSubstitutor()">getStrSubstitutor</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConfigurationStrSubstitutor()"> |
| <h3>getConfigurationStrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">getConfigurationStrSubstitutor</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getConfigurationStrSubstitutor()">getConfigurationStrSubstitutor</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAdvertiser(org.apache.logging.log4j.core.net.Advertiser)"> |
| <h3>setAdvertiser</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAdvertiser</span><wbr><span class="parameters">(<a href="../net/Advertiser.html" title="interface in org.apache.logging.log4j.core.net">Advertiser</a> advertiser)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#setAdvertiser(org.apache.logging.log4j.core.net.Advertiser)">setAdvertiser</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAdvertiser()"> |
| <h3>getAdvertiser</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../net/Advertiser.html" title="interface in org.apache.logging.log4j.core.net">Advertiser</a></span> <span class="element-name">getAdvertiser</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getAdvertiser()">getAdvertiser</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReliabilityStrategy(org.apache.logging.log4j.core.config.LoggerConfig)"> |
| <h3>getReliabilityStrategy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReliabilityStrategy.html" title="interface in org.apache.logging.log4j.core.config">ReliabilityStrategy</a></span> <span class="element-name">getReliabilityStrategy</span><wbr><span class="parameters">(<a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a> loggerConfig)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getReliabilityStrategy(org.apache.logging.log4j.core.config.LoggerConfig)">getReliabilityStrategy</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addLoggerAppender(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.core.Appender)"> |
| <h3>addLoggerAppender</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addLoggerAppender</span><wbr><span class="parameters">(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a> appender)</span></div> |
| <div class="block">Associates an Appender with a LoggerConfig. This method is synchronized in case a Logger with the same name is |
| being updated at the same time. |
| |
| Note: This method is not used when configuring via configuration. It is primarily used by unit tests.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#addLoggerAppender(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.core.Appender)">addLoggerAppender</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - The Logger the Appender will be associated with.</dd> |
| <dd><code>appender</code> - The Appender.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addLoggerFilter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.core.Filter)"> |
| <h3>addLoggerFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addLoggerFilter</span><wbr><span class="parameters">(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="block">Associates a Filter with a LoggerConfig. This method is synchronized in case a Logger with the same name is being |
| updated at the same time. |
| |
| Note: This method is not used when configuring via configuration. It is primarily used by unit tests.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#addLoggerFilter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.core.Filter)">addLoggerFilter</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - The Logger the Footer will be associated with.</dd> |
| <dd><code>filter</code> - The Filter.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLoggerAdditive(org.apache.logging.log4j.core.Logger,boolean)"> |
| <h3>setLoggerAdditive</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLoggerAdditive</span><wbr><span class="parameters">(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| boolean additive)</span></div> |
| <div class="block">Marks a LoggerConfig as additive. This method is synchronized in case a Logger with the same name is being |
| updated at the same time. |
| |
| Note: This method is not used when configuring via configuration. It is primarily used by unit tests.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#setLoggerAdditive(org.apache.logging.log4j.core.Logger,boolean)">setLoggerAdditive</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - The Logger the Appender will be associated with.</dd> |
| <dd><code>additive</code> - True if the LoggerConfig should be additive, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeAppender(java.lang.String)"> |
| <h3>removeAppender</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeAppender</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> appenderName)</span></div> |
| <div class="block">Remove an Appender. First removes any associations between LoggerConfigs and the Appender, removes the Appender |
| from this appender list and then stops the appender. This method is synchronized in case an Appender with the |
| same name is being added during the removal.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>appenderName</code> - the name of the appender to remove.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCustomLevels()"> |
| <h3>getCustomLevels</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="CustomLevelConfig.html" title="class in org.apache.logging.log4j.core.config">CustomLevelConfig</a>></span> <span class="element-name">getCustomLevels</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#getCustomLevels()">Configuration</a></code></span></div> |
| <div class="block"><p> |
| Returns a list of descriptors of the custom levels defined in the current configuration. The returned list does |
| <em>not</em> include custom levels that are defined in code with direct calls to <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html#forName(java.lang.String,int)" title="class or interface in org.apache.logging.log4j" class="external-link"><code>Level.forName(String, int)</code></a>. |
| </p> |
| <p> |
| Note that the list does not include levels of previous configurations. For example, suppose a configuration |
| contains custom levels A, B and C. The configuration is then modified to contain custom levels B, C and D. For |
| the new configuration, this method will return only {B, C, D}, that is, only the custom levels defined in |
| <em>this</em> configuration. The previously defined level A still exists (and can be obtained with |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html#getLevel(java.lang.String)" title="class or interface in org.apache.logging.log4j" class="external-link"><code>Level.getLevel(String)</code></a>), it is just not in the current configuration. <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html#values()" title="class or interface in org.apache.logging.log4j" class="external-link"><code>Level.values()</code></a> will return |
| {A, B, C, D and the built-in levels}. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getCustomLevels()">getCustomLevels</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the custom levels defined in the current configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLoggerConfig(java.lang.String)"> |
| <h3>getLoggerConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></span> <span class="element-name">getLoggerConfig</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> loggerName)</span></div> |
| <div class="block">Locates the appropriate LoggerConfig for a Logger name. This will remove tokens from the package name as |
| necessary or return the root LoggerConfig if no other matches were found.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getLoggerConfig(java.lang.String)">getLoggerConfig</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>loggerName</code> - The Logger name.</dd> |
| <dt>Returns:</dt> |
| <dd>The located LoggerConfig.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLoggerContext()"> |
| <h3>getLoggerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span> <span class="element-name">getLoggerContext</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#getLoggerContext()">Configuration</a></code></span></div> |
| <div class="block">Gets the logger context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getLoggerContext()">getLoggerContext</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the logger context.</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="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></span> <span class="element-name">getRootLogger</span>()</div> |
| <div class="block">Returns the root Logger.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getRootLogger()">getRootLogger</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the root 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/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a>></span> <span class="element-name">getLoggers</span>()</div> |
| <div class="block">Returns a Map of all the LoggerConfigs.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getLoggers()">getLoggers</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a Map with each entry containing the name of the Logger and the LoggerConfig.</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="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</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> loggerName)</span></div> |
| <div class="block">Returns the LoggerConfig with the specified name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loggerName</code> - The Logger name.</dd> |
| <dt>Returns:</dt> |
| <dd>The LoggerConfig or null if no match was found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addLogger(java.lang.String,org.apache.logging.log4j.core.config.LoggerConfig)"> |
| <h3>addLogger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addLogger</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> loggerName, |
| <a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a> loggerConfig)</span></div> |
| <div class="block">Add a loggerConfig. The LoggerConfig must already be configured with Appenders, Filters, etc. After addLogger is |
| called LoggerContext.updateLoggers must be called.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#addLogger(java.lang.String,org.apache.logging.log4j.core.config.LoggerConfig)">addLogger</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>loggerName</code> - The name of the Logger.</dd> |
| <dd><code>loggerConfig</code> - The LoggerConfig.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeLogger(java.lang.String)"> |
| <h3>removeLogger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeLogger</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> loggerName)</span></div> |
| <div class="block">Remove a LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#removeLogger(java.lang.String)">removeLogger</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>loggerName</code> - The name of the Logger.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createConfiguration(org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.LogEvent)"> |
| <h3>createConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">createConfiguration</span><wbr><span class="parameters">(<a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> node, |
| <a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#createConfiguration(org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.LogEvent)">createConfiguration</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createPluginObject(org.apache.logging.log4j.core.config.plugins.util.PluginType,org.apache.logging.log4j.core.config.Node)"> |
| <h3>createPluginObject</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">createPluginObject</span><wbr><span class="parameters">(<a href="plugins/util/PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a><?> type, |
| <a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a> node)</span></div> |
| <div class="block">This method is used by Arbiters to create specific children.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - The PluginType.</dd> |
| <dd><code>node</code> - The Node.</dd> |
| <dt>Returns:</dt> |
| <dd>The created object or null;</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toByteArray(java.io.InputStream)"> |
| <h3>toByteArray</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> is)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Reads an InputStream using buffered reads into a byte array buffer. The given InputStream will remain open after |
| invocation of this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>is</code> - the InputStream to read into a byte array buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>a byte array of the InputStream contents.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if the <code>read</code> method of the provided InputStream throws this exception.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNanoClock()"> |
| <h3>getNanoClock</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util">NanoClock</a></span> <span class="element-name">getNanoClock</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#getNanoClock()">Configuration</a></code></span></div> |
| <div class="block">Returns the <a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util"><code>NanoClock</code></a> instance for this configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#getNanoClock()">getNanoClock</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the nano clock</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNanoClock(org.apache.logging.log4j.core.util.NanoClock)"> |
| <h3>setNanoClock</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setNanoClock</span><wbr><span class="parameters">(<a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util">NanoClock</a> nanoClock)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Configuration.html#setNanoClock(org.apache.logging.log4j.core.util.NanoClock)">Configuration</a></code></span></div> |
| <div class="block">Sets the <a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util"><code>NanoClock</code></a> instance for this configuration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Configuration.html#setNanoClock(org.apache.logging.log4j.core.util.NanoClock)">setNanoClock</a></code> in interface <code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>nanoClock</code> - the new nano clock for this configuration. Must be non-null.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |