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

Class Routes

java.lang.Object

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

@Plugin(name="Routes",
        category="Core",
        printObject=true)
public final class Routes
extends java.lang.Object

Contains the individual Route elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Routes.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration
private static java.lang.String	LOG_EVENT_KEY
private static Logger	LOGGER
private java.lang.String	pattern
private AbstractScript	patternScript
private Route[]	routes

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Routes(Configuration configuration, AbstractScript patternScript, java.lang.String pattern, Route... routes)

Method Summary

Modifier and Type	Method	Description
static Routes	createRoutes(java.lang.String pattern, Route... routes)	Deprecated. since 2.7; use newBuilder().
java.lang.String	getPattern(LogEvent event, java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object> scriptStaticVariables)	Returns the pattern.
AbstractScript	getPatternScript()	Gets the optional script that decides which route to pick.
Route	getRoute(java.lang.String key)
Route[]	getRoutes()	Returns the array of Route elements.
static Routes.Builder	newBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOG_EVENT_KEY

private static final java.lang.String LOG_EVENT_KEY

See Also:

Constant Field Values

LOGGER

private static final Logger LOGGER

configuration

private final Configuration configuration

pattern

private final java.lang.String pattern

patternScript

private final AbstractScript patternScript

routes

private final Route[] routes

Constructor Detail

Routes

private Routes(Configuration configuration,
               AbstractScript patternScript,
               java.lang.String pattern,
               Route... routes)

Method Detail

createRoutes

@Deprecated
public static Routes createRoutes(java.lang.String pattern,
                                  Route... routes)

Deprecated.

since 2.7; use newBuilder().

Creates the Routes.

Parameters:

pattern - The pattern.

routes - An array of Route elements.

Returns:

The Routes container.

newBuilder

@PluginBuilderFactory
public static Routes.Builder newBuilder()

getPattern

public java.lang.String getPattern(LogEvent event,
                                   java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object> scriptStaticVariables)

Returns the pattern.

Parameters:

event - The log event passed to the script (if there is a script.)

scriptStaticVariables - The script's static variables.

Returns:

the pattern.

getPatternScript

public AbstractScript getPatternScript()

Gets the optional script that decides which route to pick.

Returns:

the optional script that decides which route to pick. May be null.

getRoute

public Route getRoute(java.lang.String key)

getRoutes

public Route[] getRoutes()

Returns the array of Route elements.

Returns:

an array of Route elements.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object