| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Constants (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.util, class: Constants"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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="class-declaration-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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Constants.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.util</a></div> |
| <h1 title="Class Constants" class="title">Class Constants</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.logging.log4j.util.Constants</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Constants</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Log4j API Constants.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.6.2</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final byte[]</code></div> |
| <div class="col-second even-row-color"><code><a href="#EMPTY_BYTE_ARRAY" class="member-name-link">EMPTY_BYTE_ARRAY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The empty array.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]</code></div> |
| <div class="col-second odd-row-color"><code><a href="#EMPTY_OBJECT_ARRAY" class="member-name-link">EMPTY_OBJECT_ARRAY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The empty array.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#ENABLE_THREADLOCALS" class="member-name-link">ENABLE_THREADLOCALS</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Kill switch for object pooling in ThreadLocals that enables much of the LOG4J2-1270 no-GC behaviour.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#IS_WEB_APP" class="member-name-link">IS_WEB_APP</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><code>true</code> if we think we are running in a web container, based on the boolean value of system property |
| "log4j2.is.webapp", or (if this system property is not set) whether the <code>javax.servlet.Servlet</code> class |
| is present in the classpath.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#JAVA_MAJOR_VERSION" class="member-name-link">JAVA_MAJOR_VERSION</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Java major version.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG4J2_DEBUG" class="member-name-link">LOG4J2_DEBUG</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Name of the system property that will turn on TRACE level internal log4j2 status logging.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#MAX_REUSABLE_MESSAGE_SIZE" class="member-name-link">MAX_REUSABLE_MESSAGE_SIZE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Maximum size of the StringBuilders used in RingBuffer LogEvents to store the contents of reusable Messages.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="IS_WEB_APP"> |
| <h3>IS_WEB_APP</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name">IS_WEB_APP</span></div> |
| <div class="block"><code>true</code> if we think we are running in a web container, based on the boolean value of system property |
| "log4j2.is.webapp", or (if this system property is not set) whether the <code>javax.servlet.Servlet</code> class |
| is present in the classpath.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ENABLE_THREADLOCALS"> |
| <h3>ENABLE_THREADLOCALS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name">ENABLE_THREADLOCALS</span></div> |
| <div class="block">Kill switch for object pooling in ThreadLocals that enables much of the LOG4J2-1270 no-GC behaviour. |
| <p> |
| <code>True</code> for non-<a href="#IS_WEB_APP"><code>web apps</code></a>, disable by setting system property |
| "log4j2.enable.threadlocals" to "false". |
| </p></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="JAVA_MAJOR_VERSION"> |
| <h3>JAVA_MAJOR_VERSION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">JAVA_MAJOR_VERSION</span></div> |
| <div class="block">Java major version.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MAX_REUSABLE_MESSAGE_SIZE"> |
| <h3>MAX_REUSABLE_MESSAGE_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">MAX_REUSABLE_MESSAGE_SIZE</span></div> |
| <div class="block">Maximum size of the StringBuilders used in RingBuffer LogEvents to store the contents of reusable Messages. |
| After a large message has been delivered to the appenders, the StringBuilder is trimmed to this size. |
| <p> |
| The default value is 518, which allows the StringBuilder to resize three times from its initial size. |
| Users can override with system property "log4j.maxReusableMsgSize". |
| </p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOG4J2_DEBUG"> |
| <h3>LOG4J2_DEBUG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">LOG4J2_DEBUG</span></div> |
| <div class="block">Name of the system property that will turn on TRACE level internal log4j2 status logging. |
| <p> |
| If system property "log4j2.debug" is either defined empty or its value equals to <code>true</code> (ignoring case), all internal log4j2 logging will be |
| printed to the console. The presence of this system property overrides any value set in the configuration's |
| <code><Configuration status="<level>" ...></code> status attribute, as well as any value set for |
| system property <code>org.apache.logging.log4j.simplelog.StatusLogger.level</code>. |
| </p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.logging.log4j.util.Constants.LOG4J2_DEBUG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EMPTY_OBJECT_ARRAY"> |
| <h3>EMPTY_OBJECT_ARRAY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]</span> <span class="element-name">EMPTY_OBJECT_ARRAY</span></div> |
| <div class="block">The empty array.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EMPTY_BYTE_ARRAY"> |
| <h3>EMPTY_BYTE_ARRAY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">byte[]</span> <span class="element-name">EMPTY_BYTE_ARRAY</span></div> |
| <div class="block">The empty array.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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> |
