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

Class RewriteAppender

java.lang.Object

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

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

All Implemented Interfaces:

Appender, Filterable, LifeCycle

public final class RewriteAppender
extends AbstractAppender

This Appender allows the logging event to be manipulated before it is processed by other Appenders.

Field Summary

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

LOGGER

Method Summary

Methods

Modifier and Type	Method and Description
void	append(LogEvent event) Modify the event and pass to the subordinate Appenders.
static RewriteAppender	createAppender(String name, String ignore, AppenderRef[] appenderRefs, Configuration config, RewritePolicy rewritePolicy, Filter filter) Create a RewriteAppender.
void	start() Start the Appender.
void	stop() Stop the Appender.

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, isStarted, parseInt, setHandler, toString

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

addFilter, getFilter, hasFilter, isFiltered, removeFilter, startFilter, stopFilter

Methods inherited from class java.lang.Object

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

Method Detail

start

public void start()

Description copied from class: AbstractAppender

Start the Appender.

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractAppender

stop

public void stop()

Description copied from class: AbstractAppender

Stop the Appender.

Specified by:

stop in interface LifeCycle

Overrides:

stop in class AbstractAppender

append

public void append(LogEvent event)

Modify the event and pass to the subordinate Appenders.

Parameters:

event - The LogEvent.

createAppender

public static RewriteAppender createAppender(String name,
                             String ignore,
                             AppenderRef[] appenderRefs,
                             Configuration config,
                             RewritePolicy rewritePolicy,
                             Filter filter)

Create a RewriteAppender.

Parameters:

name - The name of the Appender.

ignore - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.

appenderRefs - An array of Appender names to call.

config - The Configuration.

rewritePolicy - The policy to use to modify the event.

filter - A Filter to filter events.

Returns:

The created RewriteAppender.