| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ConfigurationFactory (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: ConfigurationFactory"> |
| <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/ConfigurationFactory.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><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 ConfigurationFactory" class="title">Class ConfigurationFactory</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="builder/api/ConfigurationBuilderFactory.html" title="class in org.apache.logging.log4j.core.config.builder.api">org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory</a> |
| <div class="inheritance">org.apache.logging.log4j.core.config.ConfigurationFactory</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="json/JsonConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config.json">JsonConfigurationFactory</a></code>, <code><a href="properties/PropertiesConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config.properties">PropertiesConfigurationFactory</a></code>, <code><a href="xml/XmlConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config.xml">XmlConfigurationFactory</a></code>, <code><a href="yaml/YamlConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config.yaml">YamlConfigurationFactory</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ConfigurationFactory</span> |
| <span class="extends-implements">extends <a href="builder/api/ConfigurationBuilderFactory.html" title="class in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilderFactory</a></span></div> |
| <div class="block">Factory class for parsed <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config"><code>Configuration</code></a> objects from a configuration file. |
| ConfigurationFactory allows the configuration implementation to be |
| dynamically chosen in 1 of 3 ways: |
| <ol> |
| <li>A system property named "log4j.configurationFactory" can be set with the |
| name of the ConfigurationFactory to be used.</li> |
| <li> |
| <a href="#setConfigurationFactory(org.apache.logging.log4j.core.config.ConfigurationFactory)">setConfigurationFactory(ConfigurationFactory)</a> can be called |
| with the instance of the ConfigurationFactory to be used. This must be called |
| before any other calls to Log4j.</li> |
| <li> |
| A ConfigurationFactory implementation can be added to the classpath and configured as a plugin in the |
| <a href="#CATEGORY"><code>ConfigurationFactory</code></a> category. The <a href="Order.html" title="annotation in org.apache.logging.log4j.core.config"><code>Order</code></a> annotation should be used to configure the |
| factory to be the first one inspected. See |
| <a href="xml/XmlConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config.xml">XmlConfigurationFactory</a> for an example.</li> |
| </ol> |
| |
| If the ConfigurationFactory that was added returns null on a call to |
| getConfiguration then any other ConfigurationFactories found as plugins will |
| be called in their respective order. DefaultConfiguration is always called |
| last if no configuration has been returned.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#AUTHORIZATION_PROVIDER" class="member-name-link">AUTHORIZATION_PROVIDER</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CATEGORY" class="member-name-link">CATEGORY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Plugin category used to inject a ConfigurationFactory <a href="plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>Plugin</code></a> |
| class.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#CONFIGURATION_FACTORY_PROPERTY" class="member-name-link">CONFIGURATION_FACTORY_PROPERTY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Allows the ConfigurationFactory class to be specified as a system property.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CONFIGURATION_FILE_PROPERTY" class="member-name-link">CONFIGURATION_FILE_PROPERTY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Allows the location of the configuration file to be specified as a system property.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_PREFIX" class="member-name-link">DEFAULT_PREFIX</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">File name prefix for standard configurations.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG4J1_CONFIGURATION_FILE_PROPERTY" class="member-name-link">LOG4J1_CONFIGURATION_FILE_PROPERTY</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG4J1_EXPERIMENTAL" class="member-name-link">LOG4J1_EXPERIMENTAL</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG4J1_VERSION" class="member-name-link">LOG4J1_VERSION</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG4J2_VERSION" class="member-name-link">LOG4J2_VERSION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Logger.html" title="class or interface in org.apache.logging.log4j" class="external-link">Logger</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOGGER" class="member-name-link">LOGGER</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Allows subclasses access to the status logger without creating another instance.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected final <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"><code><a href="#substitutor" class="member-name-link">substitutor</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#TEST_PREFIX" class="member-name-link">TEST_PREFIX</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">File name prefix for test configurations.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ConfigurationFactory</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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-tab1 method-summary-table-tab4"><code>static <a href="../util/AuthorizationProvider.html" title="interface in org.apache.logging.log4j.core.util">AuthorizationProvider</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#authorizationProvider(org.apache.logging.log4j.util.PropertiesUtil)" class="member-name-link">authorizationProvider</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/PropertiesUtil.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">PropertiesUtil</a> props)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../util/AuthorizationProvider.html" title="interface in org.apache.logging.log4j.core.util">AuthorizationProvider</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getAuthorizationProvider()" class="member-name-link">getAuthorizationProvider</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><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfiguration(org.apache.logging.log4j.core.LoggerContext,java.lang.String,java.net.URI)" class="member-name-link">getConfiguration</a><wbr>(<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> configLocation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the Configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfiguration(org.apache.logging.log4j.core.LoggerContext,java.lang.String,java.net.URI,java.lang.ClassLoader)" class="member-name-link">getConfiguration</a><wbr>(<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> configLocation, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a> loader)</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 Configuration obtained using a given ClassLoader.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getConfiguration(org.apache.logging.log4j.core.LoggerContext,org.apache.logging.log4j.core.config.ConfigurationSource)" class="member-name-link">getConfiguration</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> source)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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/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="#getDefaultPrefix()" class="member-name-link">getDefaultPrefix</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 method-summary-table-tab6"><code>protected <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 method-summary-table-tab6"><code><a href="#getInputFromString(java.lang.String,java.lang.ClassLoader)" class="member-name-link">getInputFromString</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> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a> loader)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFactory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance()" class="member-name-link">getInstance</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the ConfigurationFactory.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract <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-tab3"><code><a href="#getSupportedTypes()" class="member-name-link">getSupportedTypes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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/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="#getTestPrefix()" class="member-name-link">getTestPrefix</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>protected <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="#getVersion()" class="member-name-link">getVersion</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 boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isActive()" class="member-name-link">isActive</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-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#removeConfigurationFactory(org.apache.logging.log4j.core.config.ConfigurationFactory)" class="member-name-link">removeConfigurationFactory</a><wbr>(<a href="ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFactory</a> factory)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Removes the ConfigurationFactory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#resetConfigurationFactory()" class="member-name-link">resetConfigurationFactory</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Resets the ConfigurationFactory to the default.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setConfigurationFactory(org.apache.logging.log4j.core.config.ConfigurationFactory)" class="member-name-link">setConfigurationFactory</a><wbr>(<a href="ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFactory</a> factory)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Sets the configuration factory.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory">Methods inherited from class org.apache.logging.log4j.core.config.builder.api.<a href="builder/api/ConfigurationBuilderFactory.html" title="class in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilderFactory</a></h3> |
| <code><a href="builder/api/ConfigurationBuilderFactory.html#newConfigurationBuilder()">newConfigurationBuilder</a>, <a href="builder/api/ConfigurationBuilderFactory.html#newConfigurationBuilder(java.lang.Class)">newConfigurationBuilder</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> |
| </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="CONFIGURATION_FACTORY_PROPERTY"> |
| <h3>CONFIGURATION_FACTORY_PROPERTY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">CONFIGURATION_FACTORY_PROPERTY</span></div> |
| <div class="block">Allows the ConfigurationFactory class to be specified as a system property.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.CONFIGURATION_FACTORY_PROPERTY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CONFIGURATION_FILE_PROPERTY"> |
| <h3>CONFIGURATION_FILE_PROPERTY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">CONFIGURATION_FILE_PROPERTY</span></div> |
| <div class="block">Allows the location of the configuration file to be specified as a system property.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.CONFIGURATION_FILE_PROPERTY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOG4J1_CONFIGURATION_FILE_PROPERTY"> |
| <h3>LOG4J1_CONFIGURATION_FILE_PROPERTY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">LOG4J1_CONFIGURATION_FILE_PROPERTY</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.LOG4J1_CONFIGURATION_FILE_PROPERTY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOG4J1_EXPERIMENTAL"> |
| <h3>LOG4J1_EXPERIMENTAL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">LOG4J1_EXPERIMENTAL</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.LOG4J1_EXPERIMENTAL">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="AUTHORIZATION_PROVIDER"> |
| <h3>AUTHORIZATION_PROVIDER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">AUTHORIZATION_PROVIDER</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.AUTHORIZATION_PROVIDER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CATEGORY"> |
| <h3>CATEGORY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">CATEGORY</span></div> |
| <div class="block">Plugin category used to inject a ConfigurationFactory <a href="plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>Plugin</code></a> |
| class.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.CATEGORY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOGGER"> |
| <h3>LOGGER</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Logger.html" title="class or interface in org.apache.logging.log4j" class="external-link">Logger</a></span> <span class="element-name">LOGGER</span></div> |
| <div class="block">Allows subclasses access to the status logger without creating another instance.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TEST_PREFIX"> |
| <h3>TEST_PREFIX</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">TEST_PREFIX</span></div> |
| <div class="block">File name prefix for test configurations.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.TEST_PREFIX">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_PREFIX"> |
| <h3>DEFAULT_PREFIX</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">DEFAULT_PREFIX</span></div> |
| <div class="block">File name prefix for standard configurations.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.DEFAULT_PREFIX">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOG4J1_VERSION"> |
| <h3>LOG4J1_VERSION</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">LOG4J1_VERSION</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.LOG4J1_VERSION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOG4J2_VERSION"> |
| <h3>LOG4J2_VERSION</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">LOG4J2_VERSION</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.ConfigurationFactory.LOG4J2_VERSION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="substitutor"> |
| <h3>substitutor</h3> |
| <div class="member-signature"><span class="modifiers">protected final</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">substitutor</span></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>()"> |
| <h3>ConfigurationFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ConfigurationFactory</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getInstance()"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFactory</a></span> <span class="element-name">getInstance</span>()</div> |
| <div class="block">Returns the ConfigurationFactory.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the ConfigurationFactory.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="authorizationProvider(org.apache.logging.log4j.util.PropertiesUtil)"> |
| <h3>authorizationProvider</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../util/AuthorizationProvider.html" title="interface in org.apache.logging.log4j.core.util">AuthorizationProvider</a></span> <span class="element-name">authorizationProvider</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/PropertiesUtil.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">PropertiesUtil</a> props)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAuthorizationProvider()"> |
| <h3>getAuthorizationProvider</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../util/AuthorizationProvider.html" title="interface in org.apache.logging.log4j.core.util">AuthorizationProvider</a></span> <span class="element-name">getAuthorizationProvider</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConfigurationFactory(org.apache.logging.log4j.core.config.ConfigurationFactory)"> |
| <h3>setConfigurationFactory</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">setConfigurationFactory</span><wbr><span class="parameters">(<a href="ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFactory</a> factory)</span></div> |
| <div class="block">Sets the configuration factory. This method is not intended for general use and may not be thread safe.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factory</code> - the ConfigurationFactory.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resetConfigurationFactory()"> |
| <h3>resetConfigurationFactory</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">resetConfigurationFactory</span>()</div> |
| <div class="block">Resets the ConfigurationFactory to the default. This method is not intended for general use and may |
| not be thread safe.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeConfigurationFactory(org.apache.logging.log4j.core.config.ConfigurationFactory)"> |
| <h3>removeConfigurationFactory</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">removeConfigurationFactory</span><wbr><span class="parameters">(<a href="ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFactory</a> factory)</span></div> |
| <div class="block">Removes the ConfigurationFactory. This method is not intended for general use and may not be thread safe.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factory</code> - The factory to remove.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSupportedTypes()"> |
| <h3>getSupportedTypes</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</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">getSupportedTypes</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTestPrefix()"> |
| <h3>getTestPrefix</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getTestPrefix</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDefaultPrefix()"> |
| <h3>getDefaultPrefix</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDefaultPrefix</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVersion()"> |
| <h3>getVersion</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getVersion</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isActive()"> |
| <h3>isActive</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isActive</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConfiguration(org.apache.logging.log4j.core.LoggerContext,org.apache.logging.log4j.core.config.ConfigurationSource)"> |
| <h3>getConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></span> <span class="element-name">getConfiguration</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> source)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConfiguration(org.apache.logging.log4j.core.LoggerContext,java.lang.String,java.net.URI)"> |
| <h3>getConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></span> <span class="element-name">getConfiguration</span><wbr><span class="parameters">(<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> configLocation)</span></div> |
| <div class="block">Returns the Configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loggerContext</code> - The logger context</dd> |
| <dd><code>name</code> - The configuration name.</dd> |
| <dd><code>configLocation</code> - The configuration location.</dd> |
| <dt>Returns:</dt> |
| <dd>The Configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConfiguration(org.apache.logging.log4j.core.LoggerContext,java.lang.String,java.net.URI,java.lang.ClassLoader)"> |
| <h3>getConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></span> <span class="element-name">getConfiguration</span><wbr><span class="parameters">(<a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> configLocation, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a> loader)</span></div> |
| <div class="block">Returns the Configuration obtained using a given ClassLoader.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loggerContext</code> - The logger context</dd> |
| <dd><code>name</code> - The configuration name.</dd> |
| <dd><code>configLocation</code> - A URI representing the location of the configuration.</dd> |
| <dd><code>loader</code> - The default ClassLoader to use. If this is <code>null</code>, then the |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/LoaderUtil.html#getThreadContextClassLoader()" title="class or interface in org.apache.logging.log4j.util" class="external-link">default ClassLoader</a> will be used.</dd> |
| <dt>Returns:</dt> |
| <dd>The Configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInputFromString(java.lang.String,java.lang.ClassLoader)"> |
| <h3>getInputFromString</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</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">getInputFromString</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> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a> loader)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Loads the configuration from the location represented by the String.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - The configuration location.</dd> |
| <dd><code>loader</code> - The default ClassLoader to use.</dd> |
| <dt>Returns:</dt> |
| <dd>The InputSource to use to read the configuration.</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> |