org.apache.logging.log4j.core.appender.rewrite
Class RewriteAppender<T extends Serializable>

java.lang.Object
  extended by org.apache.logging.log4j.core.filter.AbstractFilterable
      extended by org.apache.logging.log4j.core.appender.AbstractAppender<T>
          extended by org.apache.logging.log4j.core.appender.rewrite.RewriteAppender<T>
All Implemented Interfaces:
Appender<T>, Filterable, LifeCycle

public final class RewriteAppender<T extends Serializable>
extends AbstractAppender<T>

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.appender.AbstractAppender
LOGGER
 
Method Summary
 void append(LogEvent event)
          Modify the event and pass to the subordinate Appenders.
static
<S extends Serializable>
RewriteAppender<S>
createAppender(String name, String suppress, 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
close, error, error, error, getHandler, getLayout, getName, isExceptionSuppressed, isStarted, 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<T extends Serializable>

stop

public void stop()
Description copied from class: AbstractAppender
Stop the Appender.

Specified by:
stop in interface LifeCycle
Overrides:
stop in class AbstractAppender<T extends Serializable>

append

public void append(LogEvent event)
Modify the event and pass to the subordinate Appenders.

Parameters:
event - The LogEvent.

createAppender

public static <S extends Serializable> RewriteAppender<S> createAppender(String name,
                                                                         String suppress,
                                                                         AppenderRef[] appenderRefs,
                                                                         Configuration config,
                                                                         RewritePolicy rewritePolicy,
                                                                         Filter filter)
Create a RewriteAppender.

Parameters:
name - The name of the Appender.
suppress - If true, exceptions will be handled in the Appender.
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.


Copyright © 1999-2013 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.