Package org.apache.logging.log4j.core
Interface Filter
- All Superinterfaces:
LifeCycle
- All Known Implementing Classes:
AbstractFilter
,BurstFilter
,CompositeFilter
,DenyAllFilter
,DynamicThresholdFilter
,LevelMatchFilter
,LevelRangeFilter
,MapFilter
,MarkerFilter
,MutableThreadContextMapFilter
,NoMarkerFilter
,RegexFilter
,ScriptFilter
,StringMatchFilter
,StructuredDataFilter
,ThreadContextMapFilter
,ThresholdFilter
,TimeFilter
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
Modifier and TypeInterfaceDescriptionstatic enum
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
Modifier and TypeFieldDescriptionstatic final String
Main plugin element type for Filter plugins.static final Filter[]
The empty array. -
Method Summary
Modifier and TypeMethodDescriptionFilter an event.Filter an event.default Filter.Result
Filter an event.Filter an event.Filter an event.Filter an event.Filter an event.filter
(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3) Filter an event.filter
(Logger logger, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4) Filter an event.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
(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
(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
(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
(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 an event.Returns the result that should be returned when the filter matches the event.Returns the result that should be returned when the filter does not match the event.
-
Field Details
-
EMPTY_ARRAY
The empty array. -
ELEMENT_TYPE
Main plugin element type for Filter plugins.- Since:
- 2.1
- See Also:
-
-
Method Details
-
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 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 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 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 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 an event.- Parameters:
logger
- The Logger.level
- The event logging Level.marker
- The Marker for the event or null.msg
- The Message- Returns:
- the Result.
-
filter
Filter an event.- Parameters:
event
- The Event to filter on.- Returns:
- the Result.
-