blob: 50de790beb05d528ae435fb18936af4217cf0950 [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:49 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Overview (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="Overview (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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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 class="title">Apache Log4j Core 2.13.3 API</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Core API table, listing packages, and an explanation">
<caption><span>Core API</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/package-summary.html">org.apache.logging.log4j.core</a></td>
<td class="colLast">
<div class="block">Implementation of Log4j 2.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Configuration table, listing packages, and an explanation">
<caption><span>Configuration</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/package-summary.html">org.apache.logging.log4j.core.config</a></td>
<td class="colLast">
<div class="block">Configuration of Log4j 2.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/builder/api/package-summary.html">org.apache.logging.log4j.core.config.builder.api</a></td>
<td class="colLast">
<div class="block">Configuration Builder API for programmatically configuring Log4j.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/builder/impl/package-summary.html">org.apache.logging.log4j.core.config.builder.impl</a></td>
<td class="colLast">
<div class="block">Configuration Builder Implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/composite/package-summary.html">org.apache.logging.log4j.core.config.composite</a></td>
<td class="colLast">
<div class="block">Support for composite configurations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/json/package-summary.html">org.apache.logging.log4j.core.config.json</a></td>
<td class="colLast">
<div class="block">Classes and interfaces supporting configuration of Log4j 2 with JSON.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/plugins/package-summary.html">org.apache.logging.log4j.core.config.plugins</a></td>
<td class="colLast">
<div class="block">Annotations for Log4j 2 plugins.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/plugins/convert/package-summary.html">org.apache.logging.log4j.core.config.plugins.convert</a></td>
<td class="colLast">
<div class="block">TypeConverter plugins for converter strings into various types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/plugins/processor/package-summary.html">org.apache.logging.log4j.core.config.plugins.processor</a></td>
<td class="colLast">
<div class="block">Java annotation processor for pre-scanning Log4j 2 plugins.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/plugins/util/package-summary.html">org.apache.logging.log4j.core.config.plugins.util</a></td>
<td class="colLast">
<div class="block">Utility and manager classes for Log4j 2 plugins.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/plugins/validation/package-summary.html">org.apache.logging.log4j.core.config.plugins.validation</a></td>
<td class="colLast">
<div class="block">Constraint validators for plugin factory methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/plugins/validation/constraints/package-summary.html">org.apache.logging.log4j.core.config.plugins.validation.constraints</a></td>
<td class="colLast">
<div class="block">Validation annotations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/plugins/validation/validators/package-summary.html">org.apache.logging.log4j.core.config.plugins.validation.validators</a></td>
<td class="colLast">
<div class="block">ConstraintValidator implementations for the constraint annotations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/plugins/visitors/package-summary.html">org.apache.logging.log4j.core.config.plugins.visitors</a></td>
<td class="colLast">
<div class="block">Visitor classes for extracting values from a Configuration or Node corresponding to a plugin annotation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/properties/package-summary.html">org.apache.logging.log4j.core.config.properties</a></td>
<td class="colLast">
<div class="block">Configuration using Properties files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/status/package-summary.html">org.apache.logging.log4j.core.config.status</a></td>
<td class="colLast">
<div class="block">Configuration classes for the <code>StatusLogger</code> API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/xml/package-summary.html">org.apache.logging.log4j.core.config.xml</a></td>
<td class="colLast">
<div class="block">Classes and interfaces supporting configuration of Log4j 2 with XML.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/config/yaml/package-summary.html">org.apache.logging.log4j.core.config.yaml</a></td>
<td class="colLast">
<div class="block">Classes and interfaces supporting configuration of Log4j 2 with YAML.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/selector/package-summary.html">org.apache.logging.log4j.core.selector</a></td>
<td class="colLast">
<div class="block">Log4j 2 Context Selectors.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Core Plugins table, listing packages, and an explanation">
<caption><span>Core Plugins</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/package-summary.html">org.apache.logging.log4j.core.appender</a></td>
<td class="colLast">
<div class="block">Log4j 2 Appenders.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/db/package-summary.html">org.apache.logging.log4j.core.appender.db</a></td>
<td class="colLast">
<div class="block">The classes in this package and sub packages provide appenders for various types of databases and methods for
accessing databases.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/db/jdbc/package-summary.html">org.apache.logging.log4j.core.appender.db.jdbc</a></td>
<td class="colLast">
<div class="block">The JDBC Appender supports writing log events to a relational database using standard JDBC connections.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/mom/package-summary.html">org.apache.logging.log4j.core.appender.mom</a></td>
<td class="colLast">
<div class="block">Message oriented middleware appenders.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/mom/jeromq/package-summary.html">org.apache.logging.log4j.core.appender.mom.jeromq</a></td>
<td class="colLast">
<div class="block">Classes and interfaces for ZeroMQ/JeroMQ support.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/mom/kafka/package-summary.html">org.apache.logging.log4j.core.appender.mom.kafka</a></td>
<td class="colLast">
<div class="block">Classes and interfaces for Kafka appender support.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/nosql/package-summary.html">org.apache.logging.log4j.core.appender.nosql</a></td>
<td class="colLast">
<div class="block">The NoSQL Appender supports writing log events to NoSQL databases.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/rewrite/package-summary.html">org.apache.logging.log4j.core.appender.rewrite</a></td>
<td class="colLast">
<div class="block">Apache Flume Appender.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/rolling/package-summary.html">org.apache.logging.log4j.core.appender.rolling</a></td>
<td class="colLast">
<div class="block">Rolling File Appender and support classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/rolling/action/package-summary.html">org.apache.logging.log4j.core.appender.rolling.action</a></td>
<td class="colLast">
<div class="block">Support classes for the Rolling File Appender.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/appender/routing/package-summary.html">org.apache.logging.log4j.core.appender.routing</a></td>
<td class="colLast">
<div class="block">Apache Flume Appender.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/filter/package-summary.html">org.apache.logging.log4j.core.filter</a></td>
<td class="colLast">
<div class="block">Log4j 2 Filter support.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/layout/package-summary.html">org.apache.logging.log4j.core.layout</a></td>
<td class="colLast">
<div class="block">Log4j 2 Layout support.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/lookup/package-summary.html">org.apache.logging.log4j.core.lookup</a></td>
<td class="colLast">
<div class="block">Log4j 2 Lookups.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/pattern/package-summary.html">org.apache.logging.log4j.core.pattern</a></td>
<td class="colLast">
<div class="block">Provides classes implementing format specifiers in conversion patterns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/script/package-summary.html">org.apache.logging.log4j.core.script</a></td>
<td class="colLast">
<div class="block">Log4j 2 Script support.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Tools table, listing packages, and an explanation">
<caption><span>Tools</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/net/package-summary.html">org.apache.logging.log4j.core.net</a></td>
<td class="colLast">
<div class="block">Log4j 2 network support.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/net/ssl/package-summary.html">org.apache.logging.log4j.core.net.ssl</a></td>
<td class="colLast">
<div class="block">Log4j 2 SSL support</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/tools/package-summary.html">org.apache.logging.log4j.core.tools</a></td>
<td class="colLast">
<div class="block">Log4j 2 command line tools.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Internals table, listing packages, and an explanation">
<caption><span>Internals</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/async/package-summary.html">org.apache.logging.log4j.core.async</a></td>
<td class="colLast">
<div class="block">Provides Asynchronous Logger classes and interfaces for low-latency logging.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/impl/package-summary.html">org.apache.logging.log4j.core.impl</a></td>
<td class="colLast">
<div class="block">Log4j 2 private implementation classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/jackson/package-summary.html">org.apache.logging.log4j.core.jackson</a></td>
<td class="colLast">
<div class="block">Classes and interfaces for serializing and deserializing Log4j 2 log events to XML and JSON using the Jackson
library.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/jmx/package-summary.html">org.apache.logging.log4j.core.jmx</a></td>
<td class="colLast">
<div class="block">Log4j 2 JMX support.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/osgi/package-summary.html">org.apache.logging.log4j.core.osgi</a></td>
<td class="colLast">
<div class="block">Collection of OSGi-specific classes for bundles.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/util/package-summary.html">org.apache.logging.log4j.core.util</a></td>
<td class="colLast">
<div class="block">Log4j 2 helper classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/util/datetime/package-summary.html">org.apache.logging.log4j.core.util.datetime</a></td>
<td class="colLast">
<div class="block">Log4j 2 date formatting classes.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Other Packages table, listing packages, and an explanation">
<caption><span>Other Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/layout/internal/package-summary.html">org.apache.logging.log4j.core.layout.internal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/message/package-summary.html">org.apache.logging.log4j.core.message</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/parser/package-summary.html">org.apache.logging.log4j.core.parser</a></td>
<td class="colLast">
<div class="block">Parsers for the output of various layouts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/time/package-summary.html">org.apache.logging.log4j.core.time</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/time/internal/package-summary.html">org.apache.logging.log4j.core.time.internal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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>