Class RegexFilter

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilter

org.apache.logging.log4j.core.filter.RegexFilter

All Implemented Interfaces:

Filter, LifeCycle, LifeCycle2

@Plugin(name="RegexFilter",
        category="Core",
        elementType="filter",
        printObject=true)
public final class RegexFilter
extends AbstractFilter

A filter that matches the given regular expression pattern against messages.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractFilter

AbstractFilter.AbstractFilterBuilder<B>

Nested classes/interfaces inherited from interface Filter

Filter.Result

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	DEFAULT_PATTERN_FLAGS
private final Pattern	pattern
private final boolean	useRawMessage

Fields inherited from class AbstractFilter

onMatch, onMismatch

Fields inherited from class AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface Filter

ELEMENT_TYPE, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RegexFilter(boolean raw, Pattern pattern, Filter.Result onMatch, Filter.Result onMismatch)

Method Summary

Modifier and Type	Method	Description
static RegexFilter	createFilter(String regex, String[] patternFlags, Boolean useRawMsg, Filter.Result match, Filter.Result mismatch)	Creates a Filter that matches a regular expression.
private Filter.Result	filter(String msg)
Filter.Result	filter(LogEvent event)	Context 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.
Filter.Result	filter(Logger logger, Level level, Marker marker, Message msg, Throwable t)	Appender Filter method.
private String	targetMessageTest(Message message)
private static int	toPatternFlags(String[] patternFlags)
String	toString()

Methods inherited from class AbstractFilter

equalsImpl, filter, filter, filter, filter, filter, filter, filter, filter, filter, filter, getOnMatch, getOnMismatch, hashCodeImpl

Methods inherited from class AbstractLifeCycle

getState, getStatusLogger, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stop

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Filter

filter

Methods inherited from interface LifeCycle

getState, initialize, isStarted, isStopped, start, stop

Field Details

DEFAULT_PATTERN_FLAGS

private static final int DEFAULT_PATTERN_FLAGS

See Also:

• Constant Field Values

pattern

private final Pattern pattern

useRawMessage

private final boolean useRawMessage

Constructor Details

RegexFilter

private RegexFilter(boolean raw,
 Pattern pattern,
 Filter.Result onMatch,
 Filter.Result onMismatch)

Method Details

filter

public Filter.Result filter(Logger logger,
 Level level,
 Marker marker,
 String msg,
 Object... params)

Description copied from class: AbstractFilter

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class AbstractFilter

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: AbstractFilter

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class AbstractFilter

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: AbstractFilter

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class AbstractFilter

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: AbstractFilter

Context Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class AbstractFilter

Parameters:

event - The LogEvent.

Returns:

The Result of filtering.

targetMessageTest

private String targetMessageTest(Message message)

filter

private Filter.Result filter(String msg)

toString

public String toString()

Overrides:

toString in class AbstractFilter

createFilter

@PluginFactory
public static RegexFilter createFilter(@PluginAttribute("regex")
 String regex,
 @PluginElement("PatternFlags")
 String[] patternFlags,
 @PluginAttribute("useRawMsg")
 Boolean useRawMsg,
 @PluginAttribute("onMatch")
 Filter.Result match,
 @PluginAttribute("onMismatch")
 Filter.Result mismatch)
                                throws IllegalArgumentException,
IllegalAccessException

Creates a Filter that matches a regular expression.

Parameters:

regex - The regular expression to match.

patternFlags - An array of Strings where each String is a Pattern.compile(String, int) compilation flag.

useRawMsg - If true, for ParameterizedMessage, StringFormattedMessage, and MessageFormatMessage, the message format pattern; for StructuredDataMessage, the message field will be used as the match target.

match - The action to perform when a match occurs.

mismatch - The action to perform when a mismatch occurs.

Returns:

The RegexFilter.

Throws:

IllegalAccessException - When there is no access to the definition of the specified member.

IllegalArgumentException - When passed an illegal or inappropriate argument.

toPatternFlags

private static int toPatternFlags(String[] patternFlags)
                           throws IllegalArgumentException,
IllegalAccessException

Throws:

IllegalArgumentException

IllegalAccessException