Google Git
Sign in
apache / logging-log4j-site / c83555f00ebe8967fddd9bc20e8f01bbccf81ea2 / . / 2.x / javadoc / log4j-core / org / apache / logging / log4j / core / config / package-summary.html
blob: 52f88af8a5b3c8e80a370f93fe8a3ad206eb91ad [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.core.config (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="package-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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.logging.log4j.core.config" class="title">Package org.apache.logging.log4j.core.config</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@Export
@Version("2.21.0")
</span>package <span class="element-name">org.apache.logging.log4j.core.config</span></div>
<section class="package-description" id="package-description">
<div class="block">Configuration of Log4j 2.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.logging.log4j.core</a></div>
<div class="col-last even-row-color">
<div class="block">Implementation of Log4j 2.</div>
</div>
<div class="col-first odd-row-color"><a href="arbiters/package-summary.html">org.apache.logging.log4j.core.config.arbiters</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="composite/package-summary.html">org.apache.logging.log4j.core.config.composite</a></div>
<div class="col-last even-row-color">
<div class="block">Support for composite configurations.</div>
</div>
<div class="col-first odd-row-color"><a href="json/package-summary.html">org.apache.logging.log4j.core.config.json</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes and interfaces supporting configuration of Log4j 2 with JSON.</div>
</div>
<div class="col-first even-row-color"><a href="plugins/package-summary.html">org.apache.logging.log4j.core.config.plugins</a></div>
<div class="col-last even-row-color">
<div class="block">Annotations for Log4j 2 plugins.</div>
</div>
<div class="col-first odd-row-color"><a href="properties/package-summary.html">org.apache.logging.log4j.core.config.properties</a></div>
<div class="col-last odd-row-color">
<div class="block">Configuration using Properties files.</div>
</div>
<div class="col-first even-row-color"><a href="status/package-summary.html">org.apache.logging.log4j.core.config.status</a></div>
<div class="col-last even-row-color">
<div class="block">Configuration classes for the <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/status/StatusLogger.html" title="class or interface in org.apache.logging.log4j.status" class="external-link"><code>StatusLogger</code></a> API.</div>
</div>
<div class="col-first odd-row-color"><a href="xml/package-summary.html">org.apache.logging.log4j.core.config.xml</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes and interfaces supporting configuration of Log4j 2 with XML.</div>
</div>
<div class="col-first even-row-color"><a href="yaml/package-summary.html">org.apache.logging.log4j.core.config.yaml</a></div>
<div class="col-last even-row-color">
<div class="block">Classes and interfaces supporting configuration of Log4j 2 with YAML.</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button><button id="class-summary-tab7" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab7', 2)" class="table-tab">Annotation Types</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractConfiguration.html" title="class in org.apache.logging.log4j.core.config">AbstractConfiguration</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The base Configuration.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AppenderControl.html" title="class in org.apache.logging.log4j.core.config">AppenderControl</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Wraps an <a href="../Appender.html" title="interface in org.apache.logging.log4j.core"><code>Appender</code></a> with details an appender implementation shouldn't need to know about.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AppenderControlArraySet.html" title="class in org.apache.logging.log4j.core.config">AppenderControlArraySet</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Data structure with similar semantics to CopyOnWriteArraySet, but giving direct access to the underlying array.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">An Appender reference.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AppendersPlugin.html" title="class in org.apache.logging.log4j.core.config">AppendersPlugin</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An Appender container.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AwaitCompletionReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">AwaitCompletionReliabilityStrategy</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">ReliabilityStrategy that counts the number of threads that have started to log an event but have not completed yet,
and waits for these threads to finish before allowing the appenders to be stopped.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AwaitUnconditionallyReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">AwaitUnconditionallyReliabilityStrategy</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Reliability strategy that sleeps unconditionally for some time before allowing a Configuration to be stopped.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface that must be implemented to create a configuration.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Indicates that a class requests the current Configuration to be injected.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="ConfigurationException.html" title="class in org.apache.logging.log4j.core.config">ConfigurationException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">This exception is thrown when an error occurs reading from, parsing, using, or initializing the Log4j 2
configuration.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ConfigurationFileWatcher.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFileWatcher</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Watcher for configuration files.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Interface used to allow components to be notified when the configuration changes.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ConfigurationScheduler.html" title="class in org.apache.logging.log4j.core.config">ConfigurationScheduler</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Represents the source for the logging configuration.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Configurator.html" title="class in org.apache.logging.log4j.core.config">Configurator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Initializes and configure the Logging system.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CronScheduledFuture.html" title="class in org.apache.logging.log4j.core.config">CronScheduledFuture</a>&lt;V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CustomLevelConfig.html" title="class in org.apache.logging.log4j.core.config">CustomLevelConfig</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Descriptor of a custom Level object that is created via configuration.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CustomLevels.html" title="class in org.apache.logging.log4j.core.config">CustomLevels</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Container for CustomLevelConfig objects.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultAdvertiser.html" title="class in org.apache.logging.log4j.core.config">DefaultAdvertiser</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The default advertiser does not do anything.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultConfiguration.html" title="class in org.apache.logging.log4j.core.config">DefaultConfiguration</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The default configuration writes all output to the Console using the default logging level.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">DefaultReliabilityStrategy</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Reliability strategy that assumes reconfigurations will never take place.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="HttpWatcher.html" title="class in org.apache.logging.log4j.core.config">HttpWatcher</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LocationAwareReliabilityStrategy.html" title="interface in org.apache.logging.log4j.core.config">LocationAwareReliabilityStrategy</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface to ensure delivery of log events to the appropriate Appenders while including location information.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LockingReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">LockingReliabilityStrategy</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">ReliabilityStrategy that uses read/write locks to prevent the LoggerConfig from stopping while it is in use.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Logger object that is created via configuration.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LoggerConfig.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.Builder</a>&lt;B extends <a href="LoggerConfig.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.Builder</a>&lt;B&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Builds LoggerConfig instances.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LoggerConfig.LevelAndRefs.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.LevelAndRefs</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="LoggerConfig.LoggerConfigPredicate.html" title="enum in org.apache.logging.log4j.core.config">LoggerConfig.LoggerConfigPredicate</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LoggerConfig.RootLogger.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The root Logger.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LoggerConfig.RootLogger.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger.Builder</a>&lt;B extends <a href="LoggerConfig.RootLogger.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger.Builder</a>&lt;B&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Builds LoggerConfig instances.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LoggerContextAware.html" title="interface in org.apache.logging.log4j.core.config">LoggerContextAware</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Indicates that a class requests the current LoggerContext to be injected.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Loggers.html" title="class in org.apache.logging.log4j.core.config">Loggers</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LoggersPlugin.html" title="class in org.apache.logging.log4j.core.config">LoggersPlugin</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Container of Logger objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Node.html" title="class in org.apache.logging.log4j.core.config">Node</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A Configuration node.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="NullConfiguration.html" title="class in org.apache.logging.log4j.core.config">NullConfiguration</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">This configuration defaults to no logging.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="Order.html" title="annotation in org.apache.logging.log4j.core.config">Order</a></div>
<div class="col-last even-row-color class-summary class-summary-tab7">
<div class="block">Identifies the relative ordering of a <a href="ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config"><code>ConfigurationFactory</code></a> plugin.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OrderComparator.html" title="class in org.apache.logging.log4j.core.config">OrderComparator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Comparator for classes annotated with <a href="Order.html" title="annotation in org.apache.logging.log4j.core.config"><code>Order</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PropertiesPlugin.html" title="class in org.apache.logging.log4j.core.config">PropertiesPlugin</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Handles properties defined in the configuration.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Represents a key/value pair in the configuration.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config">Reconfigurable</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Implemented by Configurations that can be reconfigured at runtime.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ReliabilityStrategy.html" title="interface in org.apache.logging.log4j.core.config">ReliabilityStrategy</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for objects that know how to ensure delivery of log events to the appropriate appenders, even during and
after the configuration has been modified while the system is actively used.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReliabilityStrategyFactory.html" title="class in org.apache.logging.log4j.core.config">ReliabilityStrategyFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Factory for ReliabilityStrategies.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="Scheduled.html" title="annotation in org.apache.logging.log4j.core.config">Scheduled</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">Annotation that identifies a Class as requiring a Scheduled thread.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ScriptsPlugin.html" title="class in org.apache.logging.log4j.core.config">ScriptsPlugin</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A container of Scripts.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 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>