Class StructuredDataFilter

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

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

org.apache.logging.log4j.core.filter.MapFilter

org.apache.logging.log4j.core.filter.StructuredDataFilter

All Implemented Interfaces:

Filter, LifeCycle, LifeCycle2

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

Filter based on data in a StructuredDataMessage.

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	MAX_BUFFER_SIZE
private static ThreadLocal<StringBuilder>	threadLocalStringBuilder

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	StructuredDataFilter(Map<String, List<String>> map, boolean oper, Filter.Result onMatch, Filter.Result onMismatch)

Method Summary

Modifier and Type	Method	Description
private StringBuilder	appendOrNull(String value, StringBuilder sb)
static StructuredDataFilter	createFilter(KeyValuePair[] pairs, String oper, Filter.Result match, Filter.Result mismatch)	Creates the StructuredDataFilter.
Filter.Result	filter(LogEvent event)	Context Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, Message msg, Throwable t)	Appender Filter method.
protected Filter.Result	filter(StructuredDataMessage message)
private StringBuilder	getStringBuilder()
private StringBuilder	getValue(StructuredDataMessage data, String key)
private boolean	listContainsValue(List<String> candidates, StringBuilder toMatch)

Methods inherited from class MapFilter

filter, filter, filter, filter, filter, filter, filter, filter, filter, filter, filter, filter, filter, getMap, getStringMap, isAnd, toString

Methods inherited from class AbstractFilter

equalsImpl, 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

MAX_BUFFER_SIZE

private static final int MAX_BUFFER_SIZE

See Also:

• Constant Field Values

threadLocalStringBuilder

private static ThreadLocal<StringBuilder> threadLocalStringBuilder

Constructor Details

StructuredDataFilter

private StructuredDataFilter(Map<String, List<String>> map,
 boolean oper,
 Filter.Result onMatch,
 Filter.Result onMismatch)

Method Details

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 MapFilter

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 MapFilter

Parameters:

event - The LogEvent.

Returns:

The Result of filtering.

filter

protected Filter.Result filter(StructuredDataMessage message)

getValue

private StringBuilder getValue(StructuredDataMessage data,
 String key)

getStringBuilder

private StringBuilder getStringBuilder()

appendOrNull

private StringBuilder appendOrNull(String value,
 StringBuilder sb)

listContainsValue

private boolean listContainsValue(List<String> candidates,
 StringBuilder toMatch)

createFilter

@PluginFactory
public static StructuredDataFilter createFilter(@PluginElement("Pairs")
 KeyValuePair[] pairs,
 @PluginAttribute("operator")
 String oper,
 @PluginAttribute("onMatch")
 Filter.Result match,
 @PluginAttribute("onMismatch")
 Filter.Result mismatch)

Creates the StructuredDataFilter.

Parameters:

pairs - Key and value pairs.

oper - The operator to perform. If not "or" the operation will be an "and".

match - The action to perform on a match.

mismatch - The action to perform on a mismatch.

Returns:

The StructuredDataFilter.