Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.3 / log4j-core / apidocs / org / apache / logging / log4j / core / lookup / package-summary.html
blob: 77a491d0d3278c47cbe6956c1e879e694e9b3a54 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sun May 10 12:47:47 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.logging.log4j.core.lookup (Apache Log4j Core 2.13.3 API)</title>
<meta name="date" content="2020-05-10">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.logging.log4j.core.lookup (Apache Log4j Core 2.13.3 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/layout/internal/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/message/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/lookup/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.logging.log4j.core.lookup</h1>
<div class="docSummary">
<div class="block">Log4j 2 Lookups.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a></td>
<td class="colLast">
<div class="block">Lookup a String key to a String value.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/AbstractConfigurationAwareLookup.html" title="class in org.apache.logging.log4j.core.lookup">AbstractConfigurationAwareLookup</a></td>
<td class="colLast">
<div class="block">StrLookup that is ConfigurationAware.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/AbstractLookup.html" title="class in org.apache.logging.log4j.core.lookup">AbstractLookup</a></td>
<td class="colLast">
<div class="block">A default lookup for others to extend.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/ContextMapLookup.html" title="class in org.apache.logging.log4j.core.lookup">ContextMapLookup</a></td>
<td class="colLast">
<div class="block">Looks up keys from the context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/DateLookup.html" title="class in org.apache.logging.log4j.core.lookup">DateLookup</a></td>
<td class="colLast">
<div class="block">Formats the current date or the date in the LogEvent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/EnvironmentLookup.html" title="class in org.apache.logging.log4j.core.lookup">EnvironmentLookup</a></td>
<td class="colLast">
<div class="block">Looks up keys from environment variables.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/EventLookup.html" title="class in org.apache.logging.log4j.core.lookup">EventLookup</a></td>
<td class="colLast">
<div class="block">Looks up values from the log event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/Interpolator.html" title="class in org.apache.logging.log4j.core.lookup">Interpolator</a></td>
<td class="colLast">
<div class="block">Proxies all the other <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup"><code>StrLookup</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/JavaLookup.html" title="class in org.apache.logging.log4j.core.lookup">JavaLookup</a></td>
<td class="colLast">
<div class="block">Looks up keys related to Java: Java version, JRE version, VM version, and so on.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/JmxRuntimeInputArgumentsLookup.html" title="class in org.apache.logging.log4j.core.lookup">JmxRuntimeInputArgumentsLookup</a></td>
<td class="colLast">
<div class="block">Maps JVM input arguments (but not main arguments) using JMX to acquire JVM arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/JndiLookup.html" title="class in org.apache.logging.log4j.core.lookup">JndiLookup</a></td>
<td class="colLast">
<div class="block">Looks up keys from JNDI resources.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/Log4jLookup.html" title="class in org.apache.logging.log4j.core.lookup">Log4jLookup</a></td>
<td class="colLast">
<div class="block">Lookup properties of Log4j</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/LowerLookup.html" title="class in org.apache.logging.log4j.core.lookup">LowerLookup</a></td>
<td class="colLast">
<div class="block">Converts values to lower case.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/MainMapLookup.html" title="class in org.apache.logging.log4j.core.lookup">MainMapLookup</a></td>
<td class="colLast">
<div class="block">A map-based lookup for main arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/MapLookup.html" title="class in org.apache.logging.log4j.core.lookup">MapLookup</a></td>
<td class="colLast">
<div class="block">A map-based lookup.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/MarkerLookup.html" title="class in org.apache.logging.log4j.core.lookup">MarkerLookup</a></td>
<td class="colLast">
<div class="block">Looks-up markers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/ResourceBundleLookup.html" title="class in org.apache.logging.log4j.core.lookup">ResourceBundleLookup</a></td>
<td class="colLast">
<div class="block">Looks up keys from resource bundles.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></td>
<td class="colLast">
<div class="block">A matcher class that can be queried to determine if a character array
portion matches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></td>
<td class="colLast">
<div class="block">Substitutes variables within a string by values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StructuredDataLookup.html" title="class in org.apache.logging.log4j.core.lookup">StructuredDataLookup</a></td>
<td class="colLast">
<div class="block">Looks up keys from <code>StructuredDataMessage</code> log messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/SystemPropertiesLookup.html" title="class in org.apache.logging.log4j.core.lookup">SystemPropertiesLookup</a></td>
<td class="colLast">
<div class="block">Looks up keys from system properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/lookup/UpperLookup.html" title="class in org.apache.logging.log4j.core.lookup">UpperLookup</a></td>
<td class="colLast">
<div class="block">Converts values to upper case.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.logging.log4j.core.lookup Description">Package org.apache.logging.log4j.core.lookup Description</h2>
<div class="block">Log4j 2 Lookups. These are used in variable interpolation in various configuration attributes.
<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup"><code>StrLookup</code></a> plugins should use the
<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#category--">plugin category</a>
<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html#CATEGORY"><code>Lookup</code></a>.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/layout/internal/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/message/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/lookup/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <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>
</body>
</html>