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

Class PropertiesRewritePolicy

java.lang.Object

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

All Implemented Interfaces:

RewritePolicy

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Logger	LOGGER	Allows subclasses access to the status logger without creating another instance.

Method Summary

Modifier and Type	Method	Description
static PropertiesRewritePolicy	createPolicy(Configuration config, Property[] props)	Creates a PropertiesRewritePolicy.
LogEvent	rewrite(LogEvent source)	Rewrites the event.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

protected static final Logger LOGGER

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

Method Details

rewrite

public LogEvent rewrite(LogEvent source)

Rewrites 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 String toString()

Overrides:

toString in class Object

createPolicy

@PluginFactory
public static PropertiesRewritePolicy createPolicy(@PluginConfiguration
 Configuration config,
 @PluginElement("Properties")
 Property[] props)

Creates a PropertiesRewritePolicy.

Parameters:

config - The Configuration.

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

Returns:

The PropertiesRewritePolicy.