| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.logging.log4j.spi (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.spi"> |
| <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.spi" class="title">Package org.apache.logging.log4j.spi</h1> |
| </div> |
| <hr> |
| <div class="package-signature"><span class="annotations">@Export |
| @Version("2.20.1") |
| </span>package <span class="element-name">org.apache.logging.log4j.spi</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Internal interfaces and classes to be used by authors of logging implementations or for internal use by |
| API classes.</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</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Public API for Log4j 2.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../message/package-summary.html">org.apache.logging.log4j.message</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Public Message Types used for Log4j 2.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="../simple/package-summary.html">org.apache.logging.log4j.simple</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Simple logging implementation.</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-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></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="AbstractLogger.html" title="class in org.apache.logging.log4j.spi">AbstractLogger</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Base implementation of a Logger.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractLoggerAdapter.html" title="class in org.apache.logging.log4j.spi">AbstractLoggerAdapter</a><L></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Provides an abstract base class to use for implementing LoggerAdapter.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="CleanableThreadContextMap.html" title="interface in org.apache.logging.log4j.spi">CleanableThreadContextMap</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Extension service provider interface to implement additional custom MDC behavior for |
| <a href="../ThreadContext.html" title="class in org.apache.logging.log4j"><code>ThreadContext</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="CopyOnWrite.html" title="interface in org.apache.logging.log4j.spi">CopyOnWrite</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Marker interface indicating that the implementing class is a copy-on-write data structure.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultThreadContextMap.html" title="class in org.apache.logging.log4j.spi">DefaultThreadContextMap</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The actual ThreadContext Map.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultThreadContextStack.html" title="class in org.apache.logging.log4j.spi">DefaultThreadContextStack</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A copy-on-write thread-safe variant of <code>org.apache.logging.log4j.spi.ThreadContextStack</code> in which all mutative |
| operations (add, pop, and so on) are implemented by making a fresh copy of the underlying list.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ExtendedLogger.html" title="interface in org.apache.logging.log4j.spi">ExtendedLogger</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Extends the <code>Logger</code> interface with methods that facilitate implementing or extending <code>Logger</code>s.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExtendedLoggerWrapper.html" title="class in org.apache.logging.log4j.spi">ExtendedLoggerWrapper</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Wrapper class that exposes the protected AbstractLogger methods to support wrapped loggers.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="LocationAwareLogger.html" title="interface in org.apache.logging.log4j.spi">LocationAwareLogger</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Logger that accepts the location of the caller.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LoggerAdapter.html" title="interface in org.apache.logging.log4j.spi">LoggerAdapter</a><L></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">A basic registry for <a href="LoggerContext.html" title="interface in org.apache.logging.log4j.spi"><code>LoggerContext</code></a> objects and their associated external |
| Logger classes.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="LoggerContext.html" title="interface in org.apache.logging.log4j.spi">LoggerContext</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Anchor point for logging implementations.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LoggerContextFactory.html" title="interface in org.apache.logging.log4j.spi">LoggerContextFactory</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Implemented by factories that create <a href="LoggerContext.html" title="interface in org.apache.logging.log4j.spi"><code>LoggerContext</code></a> objects.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="LoggerContextKey.html" title="class in org.apache.logging.log4j.spi">LoggerContextKey</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2">Deprecated. |
| <div class="deprecation-comment">with no replacement - no longer used</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LoggerContextShutdownAware.html" title="interface in org.apache.logging.log4j.spi">LoggerContextShutdownAware</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface allowing interested classes to know when a LoggerContext has shutdown - if the LoggerContext |
| implementation provides a way to register listeners.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="LoggerContextShutdownEnabled.html" title="interface in org.apache.logging.log4j.spi">LoggerContextShutdownEnabled</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">LoggerContexts implementing this are able register LoggerContextShutdownAware classes.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LoggerRegistry.html" title="class in org.apache.logging.log4j.spi">LoggerRegistry</a><T extends <a href="ExtendedLogger.html" title="interface in org.apache.logging.log4j.spi">ExtendedLogger</a>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Convenience class to be used by <code>LoggerContext</code> implementations.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="LoggerRegistry.ConcurrentMapFactory.html" title="class in org.apache.logging.log4j.spi">LoggerRegistry.ConcurrentMapFactory</a><T extends <a href="ExtendedLogger.html" title="interface in org.apache.logging.log4j.spi">ExtendedLogger</a>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Generates ConcurrentHashMaps for use by the registry to store the Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LoggerRegistry.MapFactory.html" title="interface in org.apache.logging.log4j.spi">LoggerRegistry.MapFactory</a><T extends <a href="ExtendedLogger.html" title="interface in org.apache.logging.log4j.spi">ExtendedLogger</a>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface to control the data structure used by the registry to store the Loggers.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="LoggerRegistry.WeakMapFactory.html" title="class in org.apache.logging.log4j.spi">LoggerRegistry.WeakMapFactory</a><T extends <a href="ExtendedLogger.html" title="interface in org.apache.logging.log4j.spi">ExtendedLogger</a>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Generates WeakHashMaps for use by the registry to store the Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MessageFactory2Adapter.html" title="class in org.apache.logging.log4j.spi">MessageFactory2Adapter</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Adapts a legacy MessageFactory to the new MessageFactory2 interface.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MutableThreadContextStack.html" title="class in org.apache.logging.log4j.spi">MutableThreadContextStack</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">TODO</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="NoOpThreadContextMap.html" title="class in org.apache.logging.log4j.spi">NoOpThreadContextMap</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block"><code>ThreadContextMap</code> implementation used when either of system properties <code>disableThreadContextMap</code> or .</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ObjectThreadContextMap.html" title="interface in org.apache.logging.log4j.spi">ObjectThreadContextMap</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Extension service provider interface to allow putting Object values in the |
| <a href="../ThreadContext.html" title="class in org.apache.logging.log4j"><code>ThreadContext</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Provider.html" title="class in org.apache.logging.log4j.spi">Provider</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Model class for a Log4j 2 provider.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ReadOnlyThreadContextMap.html" title="interface in org.apache.logging.log4j.spi">ReadOnlyThreadContextMap</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Read-only view of the data structure that implements MDC behavior for <a href="../ThreadContext.html" title="class in org.apache.logging.log4j"><code>ThreadContext</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="StandardLevel.html" title="enum in org.apache.logging.log4j.spi">StandardLevel</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Standard Logging Levels as an enumeration for use internally.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Terminable.html" title="interface in org.apache.logging.log4j.spi">Terminable</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface to be implemented by LoggerContext's that provide a shutdown method.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ThreadContextMap.html" title="interface in org.apache.logging.log4j.spi">ThreadContextMap</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Service provider interface to implement custom MDC behavior for <a href="../ThreadContext.html" title="class in org.apache.logging.log4j"><code>ThreadContext</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ThreadContextMap2.html" title="interface in org.apache.logging.log4j.spi">ThreadContextMap2</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Extension service provider interface to implement additional custom MDC behavior for |
| <a href="../ThreadContext.html" title="class in org.apache.logging.log4j"><code>ThreadContext</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ThreadContextMapFactory.html" title="class in org.apache.logging.log4j.spi">ThreadContextMapFactory</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Creates the ThreadContextMap instance used by the ThreadContext.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ThreadContextStack.html" title="interface in org.apache.logging.log4j.spi">ThreadContextStack</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Service provider interface to implement custom NDC behavior for <a href="../ThreadContext.html" title="class in org.apache.logging.log4j"><code>ThreadContext</code></a>.</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> |