| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.logging.log4j.core.lookup (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.lookup"> |
| <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.core.lookup" class="title">Package org.apache.logging.log4j.core.lookup</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.core.lookup</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Log4j 2 Lookups. These are used in variable interpolation in various configuration attributes. |
| <a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup"><code>StrLookup</code></a> plugins should use the |
| <a href="../config/plugins/Plugin.html#category()">plugin category</a> |
| <a href="StrLookup.html#CATEGORY"><code>Lookup</code></a>.</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.core</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Implementation of Log4j 2.</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></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="AbstractConfigurationAwareLookup.html" title="class in org.apache.logging.log4j.core.lookup">AbstractConfigurationAwareLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">StrLookup that is ConfigurationAware.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractLookup.html" title="class in org.apache.logging.log4j.core.lookup">AbstractLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A default lookup for others to extend.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ConfigurationStrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">ConfigurationStrSubstitutor</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block"><a href="RuntimeStrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>RuntimeStrSubstitutor</code></a> is a <a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>StrSubstitutor</code></a> which only supports recursive evaluation of lookups.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ContextMapLookup.html" title="class in org.apache.logging.log4j.core.lookup">ContextMapLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks up keys from the context.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DateLookup.html" title="class in org.apache.logging.log4j.core.lookup">DateLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Formats the current date or the date in the LogEvent.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="EnvironmentLookup.html" title="class in org.apache.logging.log4j.core.lookup">EnvironmentLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks up keys from environment variables.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="EventLookup.html" title="class in org.apache.logging.log4j.core.lookup">EventLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks up values from the log event.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Interpolator.html" title="class in org.apache.logging.log4j.core.lookup">Interpolator</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Proxies all the other <a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup"><code>StrLookup</code></a>s.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JavaLookup.html" title="class in org.apache.logging.log4j.core.lookup">JavaLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks up keys related to Java: Java version, JRE version, VM version, and so on.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JmxRuntimeInputArgumentsLookup.html" title="class in org.apache.logging.log4j.core.lookup">JmxRuntimeInputArgumentsLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Maps JVM input arguments (but not main arguments) using JMX to acquire JVM arguments.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JndiLookup.html" title="class in org.apache.logging.log4j.core.lookup">JndiLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks up keys from JNDI resources.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Log4jLookup.html" title="class in org.apache.logging.log4j.core.lookup">Log4jLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Lookup properties of Log4j</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="LookupResult.html" title="interface in org.apache.logging.log4j.core.lookup">LookupResult</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LowerLookup.html" title="class in org.apache.logging.log4j.core.lookup">LowerLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Converts values to lower case.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MainMapLookup.html" title="class in org.apache.logging.log4j.core.lookup">MainMapLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A map-based lookup for main arguments.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MapLookup.html" title="class in org.apache.logging.log4j.core.lookup">MapLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A map-based lookup.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MarkerLookup.html" title="class in org.apache.logging.log4j.core.lookup">MarkerLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks-up markers.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PropertiesLookup.html" title="class in org.apache.logging.log4j.core.lookup">PropertiesLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A lookup designed for <code>Properties</code> defined in the configuration.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ResourceBundleLookup.html" title="class in org.apache.logging.log4j.core.lookup">ResourceBundleLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks up keys from resource bundles.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RuntimeStrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">RuntimeStrSubstitutor</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block"><a href="RuntimeStrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>RuntimeStrSubstitutor</code></a> is a <a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>StrSubstitutor</code></a> which only supports evaluation of top-level lookups.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Lookup a String key to a String value.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A matcher class that can be queried to determine if a character array |
| portion matches.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Substitutes variables within a string by values.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StructuredDataLookup.html" title="class in org.apache.logging.log4j.core.lookup">StructuredDataLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks up keys from <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/StructuredDataMessage.html" title="class or interface in org.apache.logging.log4j.message" class="external-link"><code>StructuredDataMessage</code></a> log messages.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SystemPropertiesLookup.html" title="class in org.apache.logging.log4j.core.lookup">SystemPropertiesLookup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Looks up keys from system properties.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="UpperLookup.html" title="class in org.apache.logging.log4j.core.lookup">UpperLookup</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Converts values to upper case.</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> |