| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.logging.log4j (Apache Log4j API 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"> |
| <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: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </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" class="title">Package org.apache.logging.log4j</h1> |
| </div> |
| <hr> |
| <div class="package-signature"><span class="annotations">@Export |
| @Version("2.20.2") |
| </span>package <span class="element-name">org.apache.logging.log4j</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Public API for Log4j 2. |
| |
| <p> |
| The main entry point into Log4j is the <a href="LogManager.html" title="class in org.apache.logging.log4j"><code>LogManager</code></a> class which can be used to |
| obtain <a href="Logger.html" title="interface in org.apache.logging.log4j"><code>Logger</code></a> objects, the current |
| <a href="spi/LoggerContext.html" title="interface in org.apache.logging.log4j.spi"><code>LoggerContext</code></a>, a new <code>LoggerContext</code>, and the current |
| <a href="spi/LoggerContextFactory.html" title="interface in org.apache.logging.log4j.spi"><code>LoggerContextFactory</code></a>. |
| </p> |
| <p> |
| <a href="Marker.html" title="interface in org.apache.logging.log4j"><code>Marker</code></a> objects can be obtained through the |
| <a href="MarkerManager.html" title="class in org.apache.logging.log4j"><code>MarkerManager</code></a>. The MDC (Mapped Diagnostic Context) can be |
| used through the <a href="ThreadContext.html" title="class in org.apache.logging.log4j"><code>ThreadContext</code></a> class. |
| </p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="http://logging.apache.org/log4j/2.x/manual/api.html">Log4j 2 API manual</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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="message/package-summary.html">org.apache.logging.log4j.message</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Public Message Types used for Log4j 2.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="simple/package-summary.html">org.apache.logging.log4j.simple</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Simple logging implementation.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="spi/package-summary.html">org.apache.logging.log4j.spi</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Internal interfaces and classes to be used by authors of logging implementations or for internal use by |
| API classes.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="status/package-summary.html">org.apache.logging.log4j.status</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Status API for Log4j 2.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="util/package-summary.html">org.apache.logging.log4j.util</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Internal utility classes for the Log4j 2 API.</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-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></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-tab1"><a href="BridgeAware.html" title="interface in org.apache.logging.log4j">BridgeAware</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Extended interface to allow bridges between logging systems to convey the |
| correct location information.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CloseableThreadContext.html" title="class in org.apache.logging.log4j">CloseableThreadContext</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Adds entries to the <a href="ThreadContext.html" title="class in org.apache.logging.log4j"><code>stack or map</code></a> and them removes them when the object is closed, e.g.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CloseableThreadContext.Instance.html" title="class in org.apache.logging.log4j">CloseableThreadContext.Instance</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="EventLogger.html" title="class in org.apache.logging.log4j">EventLogger</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Logs "Events" that are represented as <a href="message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message"><code>StructuredDataMessage</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Levels used for identifying the severity of an event.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for constructing log events before logging them.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Logger.html" title="interface in org.apache.logging.log4j">Logger</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">This is the central interface in the log4j package.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="LoggingException.html" title="class in org.apache.logging.log4j">LoggingException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">Exception thrown when an error occurs while logging.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="LogManager.html" title="class in org.apache.logging.log4j">LogManager</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The anchor point for the Log4j logging system.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Markers are objects that are used to add easily filterable information to log messages.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MarkerManager.html" title="class in org.apache.logging.log4j">MarkerManager</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Applications create Markers by using the Marker Manager.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MarkerManager.Log4jMarker.html" title="class in org.apache.logging.log4j">MarkerManager.Log4jMarker</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block"><em>Consider this class private, it is only public to satisfy Jackson for XML and JSON IO.</em></div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ThreadContext.html" title="class in org.apache.logging.log4j">ThreadContext</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The ThreadContext allows applications to store information either in a Map or a Stack.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ThreadContext.ContextStack.html" title="interface in org.apache.logging.log4j">ThreadContext.ContextStack</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">The ThreadContext Stack interface.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </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> |
