org.apache.logging.log4j.core.filter
Class ThresholdFilter

java.lang.Object
  extended by org.apache.logging.log4j.core.filter.FilterBase
      extended by org.apache.logging.log4j.core.filter.ThresholdFilter
All Implemented Interfaces:
Filter, Lifecycle

public final class ThresholdFilter
extends FilterBase

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. For example, if the ThresholdFilter is configured with Level ERROR and the LogEvent contains Level DEBUG then the onMismatch value will be returned since ERROR events are more specific than DEBUG. The default Level is ERROR.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.Filter
Filter.Result
 
Field Summary
 
Fields inherited from class org.apache.logging.log4j.core.filter.FilterBase
LOGGER, onMatch, onMismatch
 
Method Summary
static ThresholdFilter createFilter(String loggerLevel, String match, String mismatch)
          Create a ThresholdFilter.
 Filter.Result filter(LogEvent event)
          Context Filter method.
 Filter.Result filter(Logger logger, Level level, Marker marker, Message msg, Throwable t)
          Appender Filter method.
 Filter.Result filter(Logger logger, Level level, Marker marker, Object msg, Throwable t)
          Appender Filter method.
 Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object[] params)
          Appender Filter method.
 String toString()
           
 
Methods inherited from class org.apache.logging.log4j.core.filter.FilterBase
getOnMatch, getOnMismatch, isStarted, start, stop
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

filter

public Filter.Result filter(Logger logger,
                            Level level,
                            Marker marker,
                            String msg,
                            Object[] params)
Description copied from class: FilterBase
Appender Filter method. The default returns NEUTRAL.

Specified by:
filter in interface Filter
Overrides:
filter in class FilterBase
Parameters:
logger - the Logger.
level - The logging Level.
marker - The Marker, if any.
msg - The message, if present.
params - An array of parameters or null.
Returns:
The Result of filtering.

filter

public Filter.Result filter(Logger logger,
                            Level level,
                            Marker marker,
                            Object msg,
                            Throwable t)
Description copied from class: FilterBase
Appender Filter method. The default returns NEUTRAL.

Specified by:
filter in interface Filter
Overrides:
filter in class FilterBase
Parameters:
logger - the Logger.
level - The logging Level.
marker - The Marker, if any.
msg - The message, if present.
t - A throwable or null.
Returns:
The Result of filtering.

filter

public Filter.Result filter(Logger logger,
                            Level level,
                            Marker marker,
                            Message msg,
                            Throwable t)
Description copied from class: FilterBase
Appender Filter method. The default returns NEUTRAL.

Specified by:
filter in interface Filter
Overrides:
filter in class FilterBase
Parameters:
logger - the Logger.
level - The logging Level.
marker - The Marker, if any.
msg - The message, if present.
t - A throwable or null.
Returns:
The Result of filtering.

filter

public Filter.Result filter(LogEvent event)
Description copied from class: FilterBase
Context Filter method. The default returns NEUTRAL.

Specified by:
filter in interface Filter
Overrides:
filter in class FilterBase
Parameters:
event - The LogEvent.
Returns:
The Result of filtering.

toString

public String toString()
Overrides:
toString in class FilterBase

createFilter

public static ThresholdFilter createFilter(String loggerLevel,
                                           String match,
                                           String mismatch)
Create a ThresholdFilter.

Parameters:
loggerLevel - The log Level.
match - The action to take on a match.
mismatch - The action to take on a mismatch.
Returns:
The created ThresholdFilter.


Copyright © 1999-2012 Apache Software Foundation. All Rights Reserved.