| <!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.filter (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.filter (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/config/yaml/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/impl/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/filter/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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 org.apache.logging.log4j.core.filter</h1> |
| <div class="docSummary"> |
| <div class="block">Log4j 2 Filter support.</div> |
| </div> |
| <p>See: <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"> </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/filter/Filterable.html" title="interface in org.apache.logging.log4j.core.filter">Filterable</a></td> |
| <td class="colLast"> |
| <div class="block">Interface implemented by Classes that allow filtering to occur.</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"> </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/filter/AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Users should extend this class to implement filters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilter.AbstractFilterBuilder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter.AbstractFilterBuilder</a><B extends <a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilter.AbstractFilterBuilder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter.AbstractFilterBuilder</a><B>></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></td> |
| <td class="colLast"> |
| <div class="block">Enhances a Class by allowing it to contain Filters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable.Builder</a><B extends <a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable.Builder</a><B>></td> |
| <td class="colLast"> |
| <div class="block">Subclasses can extend this abstract Builder.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html" title="class in org.apache.logging.log4j.core.filter">BurstFilter</a></td> |
| <td class="colLast"> |
| <div class="block">The <code>BurstFilter</code> is a logging filter that regulates logging traffic.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">BurstFilter.Builder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/CompositeFilter.html" title="class in org.apache.logging.log4j.core.filter">CompositeFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Composes and invokes one or more filters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.html" title="class in org.apache.logging.log4j.core.filter">DenyAllFilter</a></td> |
| <td class="colLast"> |
| <div class="block">This filter causes all logging events to be dropped.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/DenyAllFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">DenyAllFilter.Builder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/DynamicThresholdFilter.html" title="class in org.apache.logging.log4j.core.filter">DynamicThresholdFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Compares against a log level that is associated with a context value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/LevelMatchFilter.html" title="class in org.apache.logging.log4j.core.filter">LevelMatchFilter</a></td> |
| <td class="colLast"> |
| <div class="block">This filter returns the onMatch result if the logging level in the event matches the specified logging level |
| exactly.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/LevelMatchFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">LevelMatchFilter.Builder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/LevelRangeFilter.html" title="class in org.apache.logging.log4j.core.filter">LevelRangeFilter</a></td> |
| <td class="colLast"> |
| <div class="block">This filter returns the <code>onMatch</code> result if the level in the <code>LogEvent</code> is in the range of the configured |
| min and max levels, otherwise it returns <code>onMismatch</code> value .</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/MapFilter.html" title="class in org.apache.logging.log4j.core.filter">MapFilter</a></td> |
| <td class="colLast"> |
| <div class="block">A Filter that operates on a Map.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/MarkerFilter.html" title="class in org.apache.logging.log4j.core.filter">MarkerFilter</a></td> |
| <td class="colLast"> |
| <div class="block">This filter returns the onMatch result if the marker in the LogEvent is the same as or has the |
| configured marker as a parent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/NoMarkerFilter.html" title="class in org.apache.logging.log4j.core.filter">NoMarkerFilter</a></td> |
| <td class="colLast"> |
| <div class="block">This filter returns the onMatch result if there is no marker in the LogEvent.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/NoMarkerFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">NoMarkerFilter.Builder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/RegexFilter.html" title="class in org.apache.logging.log4j.core.filter">RegexFilter</a></td> |
| <td class="colLast"> |
| <div class="block">This filter returns the onMatch result if the message matches the regular expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/ScriptFilter.html" title="class in org.apache.logging.log4j.core.filter">ScriptFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Returns the onMatch result if the script returns True and returns the onMismatch value otherwise.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/StringMatchFilter.html" title="class in org.apache.logging.log4j.core.filter">StringMatchFilter</a></td> |
| <td class="colLast"> |
| <div class="block">This filter returns the onMatch result if the logging level in the event matches the specified logging level |
| exactly.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/StringMatchFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">StringMatchFilter.Builder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/StructuredDataFilter.html" title="class in org.apache.logging.log4j.core.filter">StructuredDataFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Filter based on data in a StructuredDataMessage.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/ThreadContextMapFilter.html" title="class in org.apache.logging.log4j.core.filter">ThreadContextMapFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Filter based on a value in the Thread Context Map (MDC).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/ThresholdFilter.html" title="class in org.apache.logging.log4j.core.filter">ThresholdFilter</a></td> |
| <td class="colLast"> |
| <div class="block">This filter returns the onMatch result if the level in the LogEvent is the same or more specific |
| than the configured level and the onMismatch value otherwise.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/filter/TimeFilter.html" title="class in org.apache.logging.log4j.core.filter">TimeFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Filters events that fall within a specified time period in each day.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.logging.log4j.core.filter Description">Package org.apache.logging.log4j.core.filter Description</h2> |
| <div class="block">Log4j 2 Filter support. <a href="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core"><code>Filter</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/config/Node.html#CATEGORY"><code>Core</code></a> and the |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#elementType--">element type</a> |
| <a href="../../../../../../org/apache/logging/log4j/core/Filter.html#ELEMENT_TYPE"><code>filter</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/config/yaml/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/impl/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/filter/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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 © 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> |
