org.apache.logging.log4j.core.appender.routing

Class RoutingAppender

java.lang.Object

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

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

org.apache.logging.log4j.core.appender.routing.RoutingAppender

All Implemented Interfaces:

Appender, Filterable, LifeCycle

public final class RoutingAppender
extends AbstractAppender

This Appender "routes" between various Appenders, some of which can be references to Appenders defined earlier in the configuration while others can be dynamically created within this Appender as required. Routing is achieved by specifying a pattern on the Routing appender declaration. The pattern should contain one or more substitution patterns of the form "$${[key:]token}". The pattern will be resolved each time the Appender is called using the built in StrSubstitutor and the StrLookup plugin that matches the specified key.

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) Log in Appender specific way.
static RoutingAppender	createAppender(String name, String ignore, Routes routes, Configuration config, RewritePolicy rewritePolicy, Filter filter) Create a RoutingAppender.
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)

Description copied from interface: Appender

Log in Appender specific way. When appropriate, Loggers will call the doAppend method of appender implementations in order to log.

Parameters:

event - The LogEvent.

createAppender

public static RoutingAppender createAppender(String name,
                             String ignore,
                             Routes routes,
                             Configuration config,
                             RewritePolicy rewritePolicy,
                             Filter filter)

Create a RoutingAppender.

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.

routes - The routing definitions.

config - The Configuration (automatically added by the Configuration).

rewritePolicy - A RewritePolicy, if any.

filter - A Filter to restrict events processed by the Appender or null.

Returns:

The RoutingAppender