Class ScriptFilter

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

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

org.apache.logging.log4j.core.filter.ScriptFilter

All Implemented Interfaces:

Filter, LifeCycle, LifeCycle2

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

Returns the onMatch result if the script returns True and returns the onMismatch value otherwise.

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 final Configuration	configuration
private static Logger	logger
private final AbstractScript	script

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	ScriptFilter(AbstractScript script, Configuration configuration, Filter.Result onMatch, Filter.Result onMismatch)

Method Summary

Modifier and Type	Method	Description
static ScriptFilter	createFilter(AbstractScript script, Filter.Result match, Filter.Result mismatch, Configuration configuration)	Creates the ScriptFilter.
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.
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

logger

private static Logger logger

script

private final AbstractScript script

configuration

private final Configuration configuration

Constructor Details

ScriptFilter

private ScriptFilter(AbstractScript script,
 Configuration configuration,
 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.

toString

public String toString()

Overrides:

toString in class AbstractFilter

createFilter

@PluginFactory
public static ScriptFilter createFilter(@PluginElement("Script")
 AbstractScript script,
 @PluginAttribute("onMatch")
 Filter.Result match,
 @PluginAttribute("onMismatch")
 Filter.Result mismatch,
 @PluginConfiguration
 Configuration configuration)

Creates the ScriptFilter.

Parameters:

script - The script to run. The script must return a boolean value. Either script or scriptFile must be provided.

match - The action to take if a match occurs.

mismatch - The action to take if no match occurs.

configuration - the configuration

Returns:

A ScriptFilter.