blob: 546b7e788e3ec5ef018740b7a81af3f677623dd3 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.core (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">
<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" class="title">Package org.apache.logging.log4j.core</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.core</span></div>
<section class="package-description" id="package-description">
<div class="block">Implementation 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="appender/package-summary.html">org.apache.logging.log4j.core.appender</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 Appenders.</div>
</div>
<div class="col-first odd-row-color"><a href="async/package-summary.html">org.apache.logging.log4j.core.async</a></div>
<div class="col-last odd-row-color">
<div class="block">Provides Asynchronous Logger classes and interfaces for low-latency logging.</div>
</div>
<div class="col-first even-row-color"><a href="config/package-summary.html">org.apache.logging.log4j.core.config</a></div>
<div class="col-last even-row-color">
<div class="block">Configuration of Log4j 2.</div>
</div>
<div class="col-first odd-row-color"><a href="filter/package-summary.html">org.apache.logging.log4j.core.filter</a></div>
<div class="col-last odd-row-color">
<div class="block">Log4j 2 Filter support.</div>
</div>
<div class="col-first even-row-color"><a href="impl/package-summary.html">org.apache.logging.log4j.core.impl</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 private implementation classes.</div>
</div>
<div class="col-first odd-row-color"><a href="jackson/package-summary.html">org.apache.logging.log4j.core.jackson</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes and interfaces for serializing and deserializing Log4j 2 log events to XML and JSON using the Jackson
library.</div>
</div>
<div class="col-first even-row-color"><a href="jmx/package-summary.html">org.apache.logging.log4j.core.jmx</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 JMX support.</div>
</div>
<div class="col-first odd-row-color"><a href="layout/package-summary.html">org.apache.logging.log4j.core.layout</a></div>
<div class="col-last odd-row-color">
<div class="block">Log4j 2 Layout support.</div>
</div>
<div class="col-first even-row-color"><a href="lookup/package-summary.html">org.apache.logging.log4j.core.lookup</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 Lookups.</div>
</div>
<div class="col-first odd-row-color"><a href="net/package-summary.html">org.apache.logging.log4j.core.net</a></div>
<div class="col-last odd-row-color">
<div class="block">Log4j 2 network support.</div>
</div>
<div class="col-first even-row-color"><a href="osgi/package-summary.html">org.apache.logging.log4j.core.osgi</a></div>
<div class="col-last even-row-color">
<div class="block">Collection of OSGi-specific classes for bundles.</div>
</div>
<div class="col-first odd-row-color"><a href="parser/package-summary.html">org.apache.logging.log4j.core.parser</a></div>
<div class="col-last odd-row-color">
<div class="block">Parsers for the output of various layouts.</div>
</div>
<div class="col-first even-row-color"><a href="pattern/package-summary.html">org.apache.logging.log4j.core.pattern</a></div>
<div class="col-last even-row-color">
<div class="block">Provides classes implementing format specifiers in conversion patterns.</div>
</div>
<div class="col-first odd-row-color"><a href="script/package-summary.html">org.apache.logging.log4j.core.script</a></div>
<div class="col-last odd-row-color">
<div class="block">Log4j 2 Script support.</div>
</div>
<div class="col-first even-row-color"><a href="selector/package-summary.html">org.apache.logging.log4j.core.selector</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 Context Selectors.</div>
</div>
<div class="col-first odd-row-color"><a href="time/package-summary.html">org.apache.logging.log4j.core.time</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="tools/package-summary.html">org.apache.logging.log4j.core.tools</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 command line tools.</div>
</div>
<div class="col-first odd-row-color"><a href="util/package-summary.html">org.apache.logging.log4j.core.util</a></div>
<div class="col-last odd-row-color">
<div class="block">Log4j 2 helper classes.</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="AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A life cycle to be extended.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractLogEvent.html" title="class in org.apache.logging.log4j.core">AbstractLogEvent</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">An abstract log event implementation with default values for all methods.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Appends <a href="LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a>s.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ContextDataInjector.html" title="interface in org.apache.logging.log4j.core">ContextDataInjector</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Responsible for initializing the context data of LogEvents.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Core.html" title="class in org.apache.logging.log4j.core">Core</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="DefaultLoggerContextAccessor.html" title="class in org.apache.logging.log4j.core">DefaultLoggerContextAccessor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Default implementation using the Core LoggerContext.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core">ErrorHandler</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Appenders may delegate their error handling to <code>ErrorHandlers</code>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface that must be implemented to allow custom event filtering.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">The result that can returned from a filter method call.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Lays out a <a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> in different formats.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">All proper Java frameworks implement some sort of object life cycle.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="LifeCycle.State.html" title="enum in org.apache.logging.log4j.core">LifeCycle.State</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Status of a life cycle like a <a href="LoggerContext.html" title="class in org.apache.logging.log4j.core"><code>LoggerContext</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Extends the LifeCycle interface.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Provides contextual information about a logged message.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LogEventListener.html" title="class in org.apache.logging.log4j.core">LogEventListener</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Base class for server classes that listen to <a href="LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a>s.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Logger.html" title="class in org.apache.logging.log4j.core">Logger</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The core implementation of the <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Logger.html" title="class or interface in org.apache.logging.log4j" class="external-link"><code>Logger</code></a> interface.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Logger.LoggerProxy.html" title="class in org.apache.logging.log4j.core">Logger.LoggerProxy</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Serialization proxy class for Logger.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The LoggerContext is the anchor for the logging system.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LoggerContextAccessor.html" title="interface in org.apache.logging.log4j.core">LoggerContextAccessor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Provides access to a Core Logger Context.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Instantiates the <a href="Layout.html" title="interface in org.apache.logging.log4j.core"><code>Layout</code></a> type for String-based layouts.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Version.html" title="class in org.apache.logging.log4j.core">Version</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</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>