Package org.apache.logging.log4j.core.filter

Class MutableThreadContextMapFilter

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

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

org.apache.logging.log4j.core.filter.MutableThreadContextMapFilter

All Implemented Interfaces:

Filter, LifeCycle, LifeCycle2

@Plugin(name="MutableThreadContextMapFilter",
        category="Core",
        elementType="filter",
        printObject=true)
@PluginAliases("MutableContextMapFilter")
public class MutableThreadContextMapFilter
extends AbstractFilter

Filter based on a value in the Thread Context Map (MDC).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MutableThreadContextMapFilter.Builder
static interface	MutableThreadContextMapFilter.FilterConfigUpdateListener

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.filter.AbstractFilter

AbstractFilter.AbstractFilterBuilder<B extends AbstractFilter.AbstractFilterBuilder<B>>

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.Filter

Filter.Result

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.filter.AbstractFilter

onMatch, onMismatch

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Filter

ELEMENT_TYPE

Method Summary

Modifier and Type	Method	Description
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 p0)	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, String msg, Object p0, Object p1)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)	Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, Message msg, Throwable t)	Appender Filter method.
static MutableThreadContextMapFilter.Builder	newBuilder()
void	registerListener(MutableThreadContextMapFilter.FilterConfigUpdateListener listener)
void	start()
boolean	stop(long timeout, TimeUnit timeUnit)	Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilter

equalsImpl, getOnMatch, getOnMismatch, hashCodeImpl, toString

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.Filter

filter

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, stop

Method Details

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractLifeCycle

stop

public boolean stop(long timeout,
 TimeUnit timeUnit)

Description copied from interface: LifeCycle2

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractLifeCycle

Parameters:

timeout - the maximum time to wait

timeUnit - the time unit of the timeout argument

Returns:

true if the receiver was stopped cleanly and normally, false otherwise.

registerListener

public void registerListener(MutableThreadContextMapFilter.FilterConfigUpdateListener listener)

newBuilder

@PluginBuilderFactory
public static MutableThreadContextMapFilter.Builder newBuilder()

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.

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(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,
 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,
 String msg,
 Object p0)

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.

p0 - the message parameters

Returns:

The Result of filtering.

filter

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

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.

p0 - the message parameters

p1 - the message parameters

Returns:

The Result of filtering.

filter

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

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.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
 Level level,
 Marker marker,
 String msg,
 Object p0,
 Object p1,
 Object p2,
 Object p3)

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.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
 Level level,
 Marker marker,
 String msg,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4)

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.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
 Level level,
 Marker marker,
 String msg,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5)

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.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
 Level level,
 Marker marker,
 String msg,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6)

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.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

p6 - the message parameters

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
 Level level,
 Marker marker,
 String msg,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7)

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.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

p6 - the message parameters

p7 - the message parameters

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
 Level level,
 Marker marker,
 String msg,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7,
 Object p8)

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.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

p6 - the message parameters

p7 - the message parameters

p8 - the message parameters

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
 Level level,
 Marker marker,
 String msg,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7,
 Object p8,
 Object p9)

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.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

p6 - the message parameters

p7 - the message parameters

p8 - the message parameters

p9 - the message parameters

Returns:

The Result of filtering.