Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.3 / log4j-core / apidocs / org / apache / logging / log4j / core / config / package-summary.html
blob: 09d34f76de0eab5fb32f790a4f2abecde5d76e6e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sun May 10 12:47:47 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.logging.log4j.core.config (Apache Log4j Core 2.13.3 API)</title>
<meta name="date" content="2020-05-10">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.logging.log4j.core.config (Apache Log4j Core 2.13.3 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/async/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/config/builder/api/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/config/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.logging.log4j.core.config</h1>
<div class="docSummary">
<div class="block">Configuration of Log4j 2.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></td>
<td class="colLast">
<div class="block">Interface that must be implemented to create a configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></td>
<td class="colLast">
<div class="block">Indicates that a class requests the current Configuration to be injected.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationListener.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationListener</a></td>
<td class="colLast">
<div class="block">Interface used to allow components to be notified when the configuration changes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/LocationAwareReliabilityStrategy.html" title="interface in org.apache.logging.log4j.core.config">LocationAwareReliabilityStrategy</a></td>
<td class="colLast">
<div class="block">Interface to ensure delivery of log events to the appropriate Appenders while including location information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config">Reconfigurable</a></td>
<td class="colLast">
<div class="block">Implemented by Configurations that can be reconfigured at runtime.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategy.html" title="interface in org.apache.logging.log4j.core.config">ReliabilityStrategy</a></td>
<td class="colLast">
<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>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/AbstractConfiguration.html" title="class in org.apache.logging.log4j.core.config">AbstractConfiguration</a></td>
<td class="colLast">
<div class="block">The base Configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/AppenderControl.html" title="class in org.apache.logging.log4j.core.config">AppenderControl</a></td>
<td class="colLast">
<div class="block">Wraps an <a href="../../../../../../org/apache/logging/log4j/core/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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/AppenderControlArraySet.html" title="class in org.apache.logging.log4j.core.config">AppenderControlArraySet</a></td>
<td class="colLast">
<div class="block">Data structure with similar semantics to CopyOnWriteArraySet, but giving direct access to the underlying array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a></td>
<td class="colLast">
<div class="block">An Appender reference.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/AppendersPlugin.html" title="class in org.apache.logging.log4j.core.config">AppendersPlugin</a></td>
<td class="colLast">
<div class="block">An Appender container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/AwaitCompletionReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">AwaitCompletionReliabilityStrategy</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/AwaitUnconditionallyReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">AwaitUnconditionallyReliabilityStrategy</a></td>
<td class="colLast">
<div class="block">Reliability strategy that sleeps unconditionally for some time before allowing a Configuration to be stopped.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFactory</a></td>
<td class="colLast">
<div class="block">Factory class for parsed <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config"><code>Configuration</code></a> objects from a configuration file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationFileWatcher.html" title="class in org.apache.logging.log4j.core.config">ConfigurationFileWatcher</a></td>
<td class="colLast">
<div class="block">Watcher for configuration files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationScheduler.html" title="class in org.apache.logging.log4j.core.config">ConfigurationScheduler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></td>
<td class="colLast">
<div class="block">Represents the source for the logging configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/Configurator.html" title="class in org.apache.logging.log4j.core.config">Configurator</a></td>
<td class="colLast">
<div class="block">Initializes and configure the Logging system.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/CronScheduledFuture.html" title="class in org.apache.logging.log4j.core.config">CronScheduledFuture</a>&lt;V&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/CustomLevelConfig.html" title="class in org.apache.logging.log4j.core.config">CustomLevelConfig</a></td>
<td class="colLast">
<div class="block">Descriptor of a custom Level object that is created via configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/CustomLevels.html" title="class in org.apache.logging.log4j.core.config">CustomLevels</a></td>
<td class="colLast">
<div class="block">Container for CustomLevelConfig objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/DefaultAdvertiser.html" title="class in org.apache.logging.log4j.core.config">DefaultAdvertiser</a></td>
<td class="colLast">
<div class="block">The default advertiser does not do anything.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/DefaultConfiguration.html" title="class in org.apache.logging.log4j.core.config">DefaultConfiguration</a></td>
<td class="colLast">
<div class="block">The default configuration writes all output to the Console using the default logging level.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/DefaultReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">DefaultReliabilityStrategy</a></td>
<td class="colLast">
<div class="block">Reliability strategy that assumes reconfigurations will never take place.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/HttpWatcher.html" title="class in org.apache.logging.log4j.core.config">HttpWatcher</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/LockingReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">LockingReliabilityStrategy</a></td>
<td class="colLast">
<div class="block">ReliabilityStrategy that uses read/write locks to prevent the LoggerConfig from stopping while it is in use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></td>
<td class="colLast">
<div class="block">Logger object that is created via configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.RootLogger.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger</a></td>
<td class="colLast">
<div class="block">The root Logger.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/Loggers.html" title="class in org.apache.logging.log4j.core.config">Loggers</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/LoggersPlugin.html" title="class in org.apache.logging.log4j.core.config">LoggersPlugin</a></td>
<td class="colLast">
<div class="block">Container of Logger objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/Node.html" title="class in org.apache.logging.log4j.core.config">Node</a></td>
<td class="colLast">
<div class="block">A Configuration node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/NullConfiguration.html" title="class in org.apache.logging.log4j.core.config">NullConfiguration</a></td>
<td class="colLast">
<div class="block">This configuration defaults to no logging.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/OrderComparator.html" title="class in org.apache.logging.log4j.core.config">OrderComparator</a></td>
<td class="colLast">
<div class="block">Comparator for classes annotated with <a href="../../../../../../org/apache/logging/log4j/core/config/Order.html" title="annotation in org.apache.logging.log4j.core.config"><code>Order</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/PropertiesPlugin.html" title="class in org.apache.logging.log4j.core.config">PropertiesPlugin</a></td>
<td class="colLast">
<div class="block">Handles properties defined in the configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/Property.html" title="class in org.apache.logging.log4j.core.config">Property</a></td>
<td class="colLast">
<div class="block">Represents a key/value pair in the configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategyFactory.html" title="class in org.apache.logging.log4j.core.config">ReliabilityStrategyFactory</a></td>
<td class="colLast">
<div class="block">Factory for ReliabilityStrategies.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ScriptsPlugin.html" title="class in org.apache.logging.log4j.core.config">ScriptsPlugin</a></td>
<td class="colLast">
<div class="block">A container of Scripts.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.LoggerConfigPredicate.html" title="enum in org.apache.logging.log4j.core.config">LoggerConfig.LoggerConfigPredicate</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationException.html" title="class in org.apache.logging.log4j.core.config">ConfigurationException</a></td>
<td class="colLast">
<div class="block">This exception is thrown when an error occurs reading from, parsing, using, or initializing the Log4j 2
configuration.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/Order.html" title="annotation in org.apache.logging.log4j.core.config">Order</a></td>
<td class="colLast">
<div class="block">Identifies the relative ordering of a <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationFactory.html" title="class in org.apache.logging.log4j.core.config"><code>ConfigurationFactory</code></a> plugin.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/config/Scheduled.html" title="annotation in org.apache.logging.log4j.core.config">Scheduled</a></td>
<td class="colLast">
<div class="block">Annotation that identifies a Class as requiring a Scheduled thread.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.logging.log4j.core.config Description">Package org.apache.logging.log4j.core.config Description</h2>
<div class="block">Configuration of Log4j 2.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/async/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/config/builder/api/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/config/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <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>
</body>
</html>