| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_31) on Sat Jun 09 14:24:14 MST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| BurstFilter (Log4J Core 2.0-alpha1-SNAPSHOT API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-06-09"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BurstFilter (Log4J Core 2.0-alpha1-SNAPSHOT API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BurstFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../../../org/apache/logging/log4j/core/filter/CompositeFilter.html" title="class in org.apache.logging.log4j.core.filter"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/logging/log4j/core/filter/BurstFilter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BurstFilter.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.logging.log4j.core.filter.FilterBase">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.logging.log4j.core.filter</FONT> |
| <BR> |
| Class BurstFilter</H2> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.FilterBase</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.logging.log4j.core.filter.BurstFilter</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core">Filter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/Lifecycle.html" title="interface in org.apache.logging.log4j.core">Lifecycle</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public final class <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.56"><B>BurstFilter</B></A><DT>extends <A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">FilterBase</A></DL> |
| </PRE> |
| |
| <P> |
| The <code>BurstFilter</code> is a logging filter that regulates logging |
| traffic. Use this filter when you want to control the maximum burst of log |
| statements that can be sent to an appender. The filter is configured in the |
| log4j configuration file. For example, the following configuration limits the |
| number of INFO level (as well as DEBUG and TRACE) log statements that can be sent to the |
| console to a burst of 100 with an average rate of 16 per second. WARN, ERROR and FATAL messages would continue to |
| be delivered.<br> |
| <br> |
| <p/> |
| <code> |
| <Console name="console"><br> |
| <PatternLayout pattern="%-5p %d{dd-MMM-yyyy HH:mm:ss} %x %t %m%n"/><br> |
| <filters><br> |
| <Burst level="INFO" rate="16" maxBurst="100"/><br> |
| </filters><br> |
| </Console><br> |
| </code><br> |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Nested Class Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="nested_classes_inherited_from_class_org.apache.logging.log4j.core.Filter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.<A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core">Filter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.logging.log4j.core.filter.FilterBase"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.logging.log4j.core.filter.<A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">FilterBase</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#LOGGER">LOGGER</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#onMatch">onMatch</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#onMismatch">onMismatch</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html#clear()">clear</A></B>()</CODE> |
| |
| <BR> |
| Clear the history.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html" title="class in org.apache.logging.log4j.core.filter">BurstFilter</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html#createFilter(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">createFilter</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> level, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> rate, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> maxBurst, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> match, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mismatch)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html#filter(org.apache.logging.log4j.core.LogEvent)">filter</A></B>(<A HREF="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</A> event)</CODE> |
| |
| <BR> |
| Context Filter method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, org.apache.logging.log4j.message.Message, java.lang.Throwable)">filter</A></B>(<A HREF="../../../../../../org/apache/logging/log4j/core/Logger.html" title="class in org.apache.logging.log4j.core">Logger</A> logger, |
| org.apache.logging.log4j.Level level, |
| org.apache.logging.log4j.Marker marker, |
| org.apache.logging.log4j.message.Message msg, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A> t)</CODE> |
| |
| <BR> |
| Appender Filter method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.Object, java.lang.Throwable)">filter</A></B>(<A HREF="../../../../../../org/apache/logging/log4j/core/Logger.html" title="class in org.apache.logging.log4j.core">Logger</A> logger, |
| org.apache.logging.log4j.Level level, |
| org.apache.logging.log4j.Marker marker, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> msg, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A> t)</CODE> |
| |
| <BR> |
| Appender Filter method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.String, java.lang.Object[])">filter</A></B>(<A HREF="../../../../../../org/apache/logging/log4j/core/Logger.html" title="class in org.apache.logging.log4j.core">Logger</A> logger, |
| org.apache.logging.log4j.Level level, |
| org.apache.logging.log4j.Marker marker, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> msg, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] params)</CODE> |
| |
| <BR> |
| Appender Filter method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html#getAvailable()">getAvailable</A></B>()</CODE> |
| |
| <BR> |
| Returns the number of available slots.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.logging.log4j.core.filter.FilterBase"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.logging.log4j.core.filter.<A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">FilterBase</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#getOnMatch()">getOnMatch</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#getOnMismatch()">getOnMismatch</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#isStarted()">isStarted</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#start()">start</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#stop()">stop</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.String, java.lang.Object[])"><!-- --></A><H3> |
| filter</H3> |
| <PRE> |
| public <A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A> <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.89"><B>filter</B></A>(<A HREF="../../../../../../org/apache/logging/log4j/core/Logger.html" title="class in org.apache.logging.log4j.core">Logger</A> logger, |
| org.apache.logging.log4j.Level level, |
| org.apache.logging.log4j.Marker marker, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> msg, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] params)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.String, java.lang.Object[])">FilterBase</A></CODE></B></DD> |
| <DD>Appender Filter method. The default returns NEUTRAL. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.String, java.lang.Object...)">filter</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core">Filter</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.String, java.lang.Object[])">filter</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">FilterBase</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>logger</CODE> - the Logger.<DD><CODE>level</CODE> - The logging Level.<DD><CODE>marker</CODE> - The Marker, if any.<DD><CODE>msg</CODE> - The message, if present.<DD><CODE>params</CODE> - An array of parameters or null. |
| <DT><B>Returns:</B><DD>The Result of filtering.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.Object, java.lang.Throwable)"><!-- --></A><H3> |
| filter</H3> |
| <PRE> |
| public <A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A> <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.93"><B>filter</B></A>(<A HREF="../../../../../../org/apache/logging/log4j/core/Logger.html" title="class in org.apache.logging.log4j.core">Logger</A> logger, |
| org.apache.logging.log4j.Level level, |
| org.apache.logging.log4j.Marker marker, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> msg, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A> t)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.Object, java.lang.Throwable)">FilterBase</A></CODE></B></DD> |
| <DD>Appender Filter method. The default returns NEUTRAL. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.Object, java.lang.Throwable)">filter</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core">Filter</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, java.lang.Object, java.lang.Throwable)">filter</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">FilterBase</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>logger</CODE> - the Logger.<DD><CODE>level</CODE> - The logging Level.<DD><CODE>marker</CODE> - The Marker, if any.<DD><CODE>msg</CODE> - The message, if present.<DD><CODE>t</CODE> - A throwable or null. |
| <DT><B>Returns:</B><DD>The Result of filtering.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, org.apache.logging.log4j.message.Message, java.lang.Throwable)"><!-- --></A><H3> |
| filter</H3> |
| <PRE> |
| public <A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A> <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.97"><B>filter</B></A>(<A HREF="../../../../../../org/apache/logging/log4j/core/Logger.html" title="class in org.apache.logging.log4j.core">Logger</A> logger, |
| org.apache.logging.log4j.Level level, |
| org.apache.logging.log4j.Marker marker, |
| org.apache.logging.log4j.message.Message msg, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A> t)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, org.apache.logging.log4j.message.Message, java.lang.Throwable)">FilterBase</A></CODE></B></DD> |
| <DD>Appender Filter method. The default returns NEUTRAL. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, org.apache.logging.log4j.message.Message, java.lang.Throwable)">filter</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core">Filter</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#filter(org.apache.logging.log4j.core.Logger, org.apache.logging.log4j.Level, org.apache.logging.log4j.Marker, org.apache.logging.log4j.message.Message, java.lang.Throwable)">filter</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">FilterBase</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>logger</CODE> - the Logger.<DD><CODE>level</CODE> - The logging Level.<DD><CODE>marker</CODE> - The Marker, if any.<DD><CODE>msg</CODE> - The message, if present.<DD><CODE>t</CODE> - A throwable or null. |
| <DT><B>Returns:</B><DD>The Result of filtering.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="filter(org.apache.logging.log4j.core.LogEvent)"><!-- --></A><H3> |
| filter</H3> |
| <PRE> |
| public <A HREF="../../../../../../org/apache/logging/log4j/core/Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</A> <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.102"><B>filter</B></A>(<A HREF="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</A> event)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#filter(org.apache.logging.log4j.core.LogEvent)">FilterBase</A></CODE></B></DD> |
| <DD>Context Filter method. The default returns NEUTRAL. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html#filter(org.apache.logging.log4j.core.LogEvent)">filter</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core">Filter</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#filter(org.apache.logging.log4j.core.LogEvent)">filter</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">FilterBase</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>event</CODE> - The LogEvent. |
| <DT><B>Returns:</B><DD>The Result of filtering.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAvailable()"><!-- --></A><H3> |
| getAvailable</H3> |
| <PRE> |
| public int <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.136"><B>getAvailable</B></A>()</PRE> |
| <DL> |
| <DD>Returns the number of available slots. Used for unit testing. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The number of available slots.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clear()"><!-- --></A><H3> |
| clear</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.143"><B>clear</B></A>()</PRE> |
| <DL> |
| <DD>Clear the history. Used for unit testing. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.152"><B>toString</B></A>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/logging/log4j/core/filter/FilterBase.html" title="class in org.apache.logging.log4j.core.filter">FilterBase</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createFilter(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| createFilter</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/apache/logging/log4j/core/filter/BurstFilter.html" title="class in org.apache.logging.log4j.core.filter">BurstFilter</A> <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/filter/BurstFilter.html#line.217"><B>createFilter</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> level, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> rate, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> maxBurst, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> match, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mismatch)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>level</CODE> - The logging level.<DD><CODE>rate</CODE> - The average number of events per second to allow.<DD><CODE>maxBurst</CODE> - The maximum number of events that can occur before events are filtered for exceeding the |
| average rate. The default is 10 times the rate.<DD><CODE>match</CODE> - The Result to return when the filter matches. Defaults to Result.NEUTRAL.<DD><CODE>mismatch</CODE> - The Result to return when the filter does not match. The default is Result.DENY. |
| <DT><B>Returns:</B><DD>A BurstFilter.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BurstFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../../../org/apache/logging/log4j/core/filter/CompositeFilter.html" title="class in org.apache.logging.log4j.core.filter"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/logging/log4j/core/filter/BurstFilter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BurstFilter.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.logging.log4j.core.filter.FilterBase">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 1999-2012 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
