org.apache.logging.log4j.core.appender.rewrite

Class MapRewritePolicy

java.lang.Object

org.apache.logging.log4j.core.appender.rewrite.MapRewritePolicy

All Implemented Interfaces:

RewritePolicy

@Plugin(name="MapRewritePolicy",
        category="Core",
        elementType="rewritePolicy",
        printObject=true)
public final class MapRewritePolicy
extends java.lang.Object
implements RewritePolicy

This policy modifies events by replacing or possibly adding keys and values to the MapMessage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapRewritePolicy.Mode An enumeration to identify whether keys not in the MapMessage should be added or whether only existing keys should be updated.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER Allow subclasses access to the status logger without creating another instance.
private java.util.Map<java.lang.String,java.lang.String>	map
private MapRewritePolicy.Mode	mode

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MapRewritePolicy(java.util.Map<java.lang.String,java.lang.String> map, MapRewritePolicy.Mode mode)

Method Summary

Modifier and Type	Method and Description
static MapRewritePolicy	createPolicy(java.lang.String mode, KeyValuePair[] pairs) The factory method to create the MapRewritePolicy.
LogEvent	rewrite(LogEvent source) Rewrite the event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final Logger LOGGER

Allow subclasses access to the status logger without creating another instance.

map

private final java.util.Map<java.lang.String,java.lang.String> map

mode

private final MapRewritePolicy.Mode mode

Constructor Detail

MapRewritePolicy

private MapRewritePolicy(java.util.Map<java.lang.String,java.lang.String> map,
                         MapRewritePolicy.Mode mode)

Method Detail

rewrite

public LogEvent rewrite(LogEvent source)

Rewrite the event.

Specified by:

rewrite in interface RewritePolicy

Parameters:

source - a logging event that may be returned or used to create a new logging event.

Returns:

The LogEvent after rewriting.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createPolicy

@PluginFactory
public static MapRewritePolicy createPolicy(@PluginAttribute(value="mode")
                                                           java.lang.String mode,
                                                           @PluginElement(value="KeyValuePair")
                                                           KeyValuePair[] pairs)

The factory method to create the MapRewritePolicy.

Parameters:

mode - The string representation of the Mode.

pairs - key/value pairs for the new Map keys and values.

Returns:

The MapRewritePolicy.