Package org.apache.logging.log4j.core
Interface Filter
-
- All Superinterfaces:
LifeCycle
- All Known Implementing Classes:
AbstractFilter
,BurstFilter
,CompositeFilter
,DenyAllFilter
,DynamicThresholdFilter
,FilterAdapter
,LevelMatchFilter
,LevelRangeFilter
,MapFilter
,MarkerFilter
,NoMarkerFilter
,RegexFilter
,ScriptFilter
,StringMatchFilter
,StructuredDataFilter
,ThreadContextMapFilter
,ThresholdFilter
,TimeFilter
public interface Filter extends LifeCycle
Interface that must be implemented to allow custom event filtering. It is highly recommended that applications make use of the Filters provided with this implementation before creating their own.This interface supports "global" filters (i.e. - all events must pass through them first), attached to specific loggers and associated with Appenders. It is recommended that, where possible, Filter implementations create a generic filtering method that can be called from any of the filter methods.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Filter.Result
The result that can returned from a filter method call.-
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
-
Field Summary
Fields Modifier and Type Field Description static String
ELEMENT_TYPE
Main plugin element type for Filter plugins.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Filter.Result
filter(LogEvent event)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, Object msg, Throwable t)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String msg, Object... params)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)
Filter an event.Filter.Result
filter(Logger logger, Level level, Marker marker, Message msg, Throwable t)
Filter an event.Filter.Result
getOnMatch()
Returns the result that should be returned when the filter matches the event.Filter.Result
getOnMismatch()
Returns the result that should be returned when the filter does not match the event.
-
-
-
Field Detail
-
ELEMENT_TYPE
static final String ELEMENT_TYPE
Main plugin element type for Filter plugins.- Since:
- 2.1
- See Also:
- Constant Field Values
-
-
Method Detail
-
getOnMismatch
Filter.Result getOnMismatch()
Returns the result that should be returned when the filter does not match the event.- Returns:
- the Result that should be returned when the filter does not match the event.
-
getOnMatch
Filter.Result getOnMatch()
Returns the result that should be returned when the filter matches the event.- Returns:
- the Result that should be returned when the filter matches the event.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object... params)
Filter an event.- Parameters:
logger
- The Logger.level
- The event logging Level.marker
- The Marker for the event or null.msg
- String text to filter on.params
- An array of parameters or null.- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parametersp2
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parametersp8
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)
Filter an event.- Parameters:
logger
- The Logger.level
- the event logging level.marker
- The Marker for the event or null.message
- The message.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parametersp8
- the message parametersp9
- the message parameters- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, Object msg, Throwable t)
Filter an event.- Parameters:
logger
- The Logger.level
- The event logging Level.marker
- The Marker for the event or null.msg
- Any Object.t
- A Throwable or null.- Returns:
- the Result.
-
filter
Filter.Result filter(Logger logger, Level level, Marker marker, Message msg, Throwable t)
Filter an event.- Parameters:
logger
- The Logger.level
- The event logging Level.marker
- The Marker for the event or null.msg
- The Messaget
- A Throwable or null.- Returns:
- the Result.
-
filter
Filter.Result filter(LogEvent event)
Filter an event.- Parameters:
event
- The Event to filter on.- Returns:
- the Result.
-
-