blob: c05d945242c45c79897a8f5282695f5c40a4e7e2 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) -->
<title>Deprecated List (Apache Log4j API 2.25.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="deprecated elements">
<meta name="generator" content="javadoc/DeprecatedListWriter">
<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.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="deprecated-list-page">
<script type="text/javascript">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>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#deprecated">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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="Deprecated API" class="title">Deprecated API</h1>
<h2 title="Contents">Contents</h2>
<ul>
<li><a href="#interface">Interfaces</a></li>
<li><a href="#class">Classes</a></li>
<li><a href="#field">Fields</a></li>
<li><a href="#method">Methods</a></li>
<li><a href="#constructor">Constructors</a></li>
</ul>
</div>
<ul class="block-list">
<li>
<div id="interface">
<div class="caption"><span>Deprecated Interfaces</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/CopyOnWrite.html" title="interface in org.apache.logging.log4j.spi">org.apache.logging.log4j.spi.CopyOnWrite</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Since 2.24.0 no class implements this.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/LoggerRegistry.MapFactory.html" title="interface in org.apache.logging.log4j.spi">org.apache.logging.log4j.spi.LoggerRegistry.MapFactory</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">As of version <code>2.25.0</code>, planned to be removed!</div>
</div>
</div>
</div>
</li>
</ul>
<ul class="block-list">
<li>
<div id="class">
<div class="caption"><span>Deprecated Classes</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/EventLogger.html" title="class in org.apache.logging.log4j">org.apache.logging.log4j.EventLogger</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Deprecated since 2.24.0.
<a href="org/apache/logging/log4j/Logger.html" title="interface in org.apache.logging.log4j"><code>Logger</code></a> accepts <a href="org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message"><code>StructuredDataMessage</code></a>s, users should use to that instead.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/LoggerContextKey.html" title="class in org.apache.logging.log4j.spi">org.apache.logging.log4j.spi.LoggerContextKey</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">with no replacement - no longer used</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/LoggerRegistry.ConcurrentMapFactory.html" title="class in org.apache.logging.log4j.spi">org.apache.logging.log4j.spi.LoggerRegistry.ConcurrentMapFactory</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">As of version <code>2.25.0</code>, planned to be removed!</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/LoggerRegistry.WeakMapFactory.html" title="class in org.apache.logging.log4j.spi">org.apache.logging.log4j.spi.LoggerRegistry.WeakMapFactory</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">As of version <code>2.25.0</code>, planned to be removed!</div>
</div>
</div>
</div>
</li>
</ul>
<ul class="block-list">
<li>
<div id="field">
<div class="caption"><span>Deprecated Fields</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/LogManager.html#FACTORY_PROPERTY_NAME">org.apache.logging.log4j.LogManager.FACTORY_PROPERTY_NAME</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Replaced since 2.24.0 with <a href="org/apache/logging/log4j/spi/Provider.html#PROVIDER_PROPERTY_NAME">"log4j.provider"</a>.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/Provider.html#FACTORY_PRIORITY">org.apache.logging.log4j.spi.Provider.FACTORY_PRIORITY</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">since 2.24.0</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/Provider.html#LOGGER_CONTEXT_FACTORY">org.apache.logging.log4j.spi.Provider.LOGGER_CONTEXT_FACTORY</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">since 2.24.0</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/Provider.html#THREAD_CONTEXT_MAP">org.apache.logging.log4j.spi.Provider.THREAD_CONTEXT_MAP</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">since 2.24.0</div>
</div>
</div>
</div>
</li>
</ul>
<ul class="block-list">
<li>
<div id="method">
<div class="caption"><span>Deprecated Methods</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/Logger.html#entry()">org.apache.logging.log4j.Logger.entry()</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Since 2.6, use <a href="org/apache/logging/log4j/Logger.html#traceEntry()"><code>Logger.traceEntry()</code></a> instead which performs the same function.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/Logger.html#entry(java.lang.Object...)">org.apache.logging.log4j.Logger.entry<wbr>(Object...)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">since 2.11.2, use <a href="org/apache/logging/log4j/Logger.html#traceEntry(java.lang.String,java.lang.Object...)"><code>Logger.traceEntry(String, Object...)</code></a> instead which performs the same function.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/Logger.html#exit()">org.apache.logging.log4j.Logger.exit()</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Since 2.6, use <a href="org/apache/logging/log4j/Logger.html#traceExit()"><code>Logger.traceExit()</code></a> instead which performs the same function.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/Logger.html#exit(R)">org.apache.logging.log4j.Logger.exit<wbr>(R)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">Since 2.6, use <a href="org/apache/logging/log4j/Logger.html#traceExit(R)"><code>Logger.traceExit(Object)</code></a> instead which performs the same function.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/MarkerManager.html#getMarker(java.lang.String,java.lang.String)">org.apache.logging.log4j.MarkerManager.getMarker<wbr>(String, String)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Use the Marker add or set methods to add parent Markers. Will be removed by final GA release.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/MarkerManager.html#getMarker(java.lang.String,org.apache.logging.log4j.Marker)">org.apache.logging.log4j.MarkerManager.getMarker<wbr>(String, Marker)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">Use the Marker add or set methods to add parent Markers. Will be removed by final GA release.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/message/Message.html#getFormat()">org.apache.logging.log4j.message.Message.getFormat()</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Deprecated since version <code>2.24.0</code>.
Use <a href="org/apache/logging/log4j/message/MultiformatMessage.html" title="interface in org.apache.logging.log4j.message"><code>MultiformatMessage</code></a> instead to implement messages that can format themselves in one or more encodings.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/message/StructuredDataId.html#makeId(java.lang.String,int)">org.apache.logging.log4j.message.StructuredDataId.makeId<wbr>(String, int)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">Since 2.18.0, use <a href="org/apache/logging/log4j/message/StructuredDataId.html#makeId(java.lang.String,java.lang.String)"><code>StructuredDataId.makeId(String, String)</code></a> instead</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/AbstractLogger.html#checkMessageFactory(org.apache.logging.log4j.spi.ExtendedLogger,org.apache.logging.log4j.message.MessageFactory)">org.apache.logging.log4j.spi.AbstractLogger.checkMessageFactory<wbr>(ExtendedLogger, MessageFactory)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">As of version <code>2.25.0</code>, planned to be removed!
Instead, in <a href="org/apache/logging/log4j/spi/LoggerContext.html#getLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)"><code>LoggerContext.getLogger(String, MessageFactory)</code></a> implementations, namespace loggers with message factories.
If your implementation uses <a href="org/apache/logging/log4j/spi/LoggerRegistry.html" title="class in org.apache.logging.log4j.spi"><code>LoggerRegistry</code></a>, you are already covered.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/AbstractLogger.html#enter(java.lang.String,java.lang.String,org.apache.logging.log4j.util.MessageSupplier...)">org.apache.logging.log4j.spi.AbstractLogger.enter<wbr>(String, String, MessageSupplier...)</a></div>
<div class="col-last odd-row-color"></div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/AbstractLogger.html#enter(java.lang.String,org.apache.logging.log4j.util.MessageSupplier)">org.apache.logging.log4j.spi.AbstractLogger.enter<wbr>(String, MessageSupplier)</a></div>
<div class="col-last even-row-color"></div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/AbstractLogger.html#entry()">org.apache.logging.log4j.spi.AbstractLogger.entry()</a></div>
<div class="col-last odd-row-color"></div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/AbstractLogger.html#entry(java.lang.Object...)">org.apache.logging.log4j.spi.AbstractLogger.entry<wbr>(Object...)</a></div>
<div class="col-last even-row-color"></div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/AbstractLogger.html#exit()">org.apache.logging.log4j.spi.AbstractLogger.exit()</a></div>
<div class="col-last odd-row-color"></div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/AbstractLogger.html#exit(R)">org.apache.logging.log4j.spi.AbstractLogger.exit<wbr>(R)</a></div>
<div class="col-last even-row-color"></div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/LoggerRegistry.html#getLogger(java.lang.String)">org.apache.logging.log4j.spi.LoggerRegistry.getLogger<wbr>(String)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">As of version <code>2.25.0</code>, planned to be removed!
Use <a href="org/apache/logging/log4j/spi/LoggerRegistry.html#getLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)"><code>LoggerRegistry.getLogger(String, MessageFactory)</code></a> instead.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/LoggerRegistry.html#hasLogger(java.lang.String)">org.apache.logging.log4j.spi.LoggerRegistry.hasLogger<wbr>(String)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">As of version <code>2.25.0</code>, planned to be removed!
Use <a href="org/apache/logging/log4j/spi/LoggerRegistry.html#hasLogger(java.lang.String,org.apache.logging.log4j.message.MessageFactory)"><code>LoggerRegistry.hasLogger(String, MessageFactory)</code></a> instead.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/Provider.html#getUrl()">org.apache.logging.log4j.spi.Provider.getUrl()</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">since 2.24.0, without a replacement.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/status/StatusConsoleListener.html#setFilters(java.lang.String...)">org.apache.logging.log4j.status.StatusConsoleListener.setFilters<wbr>(String...)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">since 2.23.0, this method is ineffective and only kept for binary backward compatibility.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/status/StatusData.html#getTimestamp()">org.apache.logging.log4j.status.StatusData.getTimestamp()</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">since 2.23.0, use <a href="org/apache/logging/log4j/status/StatusData.html#getInstant()"><code>StatusData.getInstant()</code></a> instead.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/status/StatusLogger.html#clear()">org.apache.logging.log4j.status.StatusLogger.clear()</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Since 2.23.0, instead of relying on the buffering provided by <code>StatusLogger</code>,
users should register their own listeners to access to logged events.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/status/StatusLogger.html#getStatusData()">org.apache.logging.log4j.status.StatusLogger.getStatusData()</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">Since 2.23.0, instead of relying on the buffering provided by <code>StatusLogger</code>,
users should register their own listeners to access to logged events.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/status/StatusLogger.html#setLevel(org.apache.logging.log4j.Level)">org.apache.logging.log4j.status.StatusLogger.setLevel<wbr>(Level)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Since 2.23.0, instead use the <a href="org/apache/logging/log4j/status/StatusConsoleListener.html#setLevel(org.apache.logging.log4j.Level)"><code>setLevel(Level)</code></a> method
on the fallback listener returned by <a href="org/apache/logging/log4j/status/StatusLogger.html#getFallbackListener()"><code>StatusLogger.getFallbackListener()</code></a>.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/status/StatusLogger.html#updateListenerLevel(org.apache.logging.log4j.Level)">org.apache.logging.log4j.status.StatusLogger.updateListenerLevel<wbr>(Level)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">Since 2.23.0, instead use the <a href="org/apache/logging/log4j/status/StatusConsoleListener.html#setLevel(org.apache.logging.log4j.Level)"><code>setLevel(Level)</code></a> method
on the fallback listener returned by <a href="org/apache/logging/log4j/status/StatusLogger.html#getFallbackListener()"><code>StatusLogger.getFallbackListener()</code></a>.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/util/Base64Util.html#encode(java.lang.String)">org.apache.logging.log4j.util.Base64Util.encode<wbr>(String)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">since 2.22.0, use <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Base64.html" title="class or interface in java.util" class="external-link"><code>Base64</code></a> instead.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/util/PropertiesUtil.html#reload()">org.apache.logging.log4j.util.PropertiesUtil.reload()</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">since 2.24.0 caching of property values is disabled.</div>
</div>
</div>
</div>
</li>
</ul>
<ul class="block-list">
<li>
<div id="constructor">
<div class="caption"><span>Deprecated Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/message/ParameterizedMessage.html#%3Cinit%3E(java.lang.String,java.lang.String%5B%5D,java.lang.Throwable)">org.apache.logging.log4j.message.ParameterizedMessage<wbr>(String, String[], Throwable)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Since 2.6, use <a href="org/apache/logging/log4j/message/ParameterizedMessage.html#%3Cinit%3E(java.lang.String,java.lang.Object,java.lang.Object)"><code>ParameterizedMessage(String, Object[], Throwable)</code></a> instead</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/message/StructuredDataId.html#%3Cinit%3E(java.lang.String,int,java.lang.String%5B%5D,java.lang.String%5B%5D)">org.apache.logging.log4j.message.StructuredDataId<wbr>(String, int, String[], String[])</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">Since 2.18.0, use <a href="org/apache/logging/log4j/message/StructuredDataId.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String%5B%5D,java.lang.String%5B%5D)"><code>StructuredDataId(String, String, String[], String[])</code></a> instead.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/message/StructuredDataId.html#%3Cinit%3E(java.lang.String,int,java.lang.String%5B%5D,java.lang.String%5B%5D,int)">org.apache.logging.log4j.message.StructuredDataId<wbr>(String, int, String[], String[], int)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Since 2.18.0, use <a href="org/apache/logging/log4j/message/StructuredDataId.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String%5B%5D,java.lang.String%5B%5D,int)"><code>StructuredDataId(String, String, String[], String[], int)</code></a> instead.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/DefaultThreadContextMap.html#%3Cinit%3E(boolean)">org.apache.logging.log4j.spi.DefaultThreadContextMap<wbr>(boolean)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">Since 2.24.0. Use <a href="org/apache/logging/log4j/spi/NoOpThreadContextMap.html" title="class in org.apache.logging.log4j.spi"><code>NoOpThreadContextMap</code></a> for a no-op implementation.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/DefaultThreadContextStack.html#%3Cinit%3E(boolean)">org.apache.logging.log4j.spi.DefaultThreadContextStack<wbr>(boolean)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">since 2.24.0 without a replacement.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="org/apache/logging/log4j/spi/LoggerRegistry.html#%3Cinit%3E(org.apache.logging.log4j.spi.LoggerRegistry.MapFactory)">org.apache.logging.log4j.spi.LoggerRegistry<wbr>(LoggerRegistry.MapFactory&lt;T&gt;)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">As of version <code>2.25.0</code>, planned to be removed!</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="org/apache/logging/log4j/spi/Provider.html#%3Cinit%3E(java.util.Properties,java.net.URL,java.lang.ClassLoader)">org.apache.logging.log4j.spi.Provider<wbr>(Properties, URL, ClassLoader)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">since 2.24.0</div>
</div>
</div>
</div>
</li>
</ul>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center">Copyright &copy; 1999-2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>.All Rights Reserved.<br/>Apache, Log4j, and the Apache feather logo are trademarks or registered trademarks of <a href="https://www.apache.org/">The Apache Software Foundation</a>.Oracle and Java are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.</p></small></p>
</footer>
</div>
</div>
</body>
</html>