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

Class Route

java.lang.Object

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

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

A Route to an appender.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	appenderRef
private java.lang.String	key
private static Logger	LOGGER
private Node	node

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Route(Node node, java.lang.String appenderRef, java.lang.String key)

Method Summary

Modifier and Type	Method	Description
static Route	createRoute(java.lang.String appenderRef, java.lang.String key, Node node)	Create the Route.
java.lang.String	getAppenderRef()	Returns the appender reference.
java.lang.String	getKey()	Returns the key for this Route.
Node	getNode()	Returns the Dynamic Appender Node.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

node

private final Node node

appenderRef

private final java.lang.String appenderRef

key

private final java.lang.String key

Constructor Detail

Route

private Route(Node node,
              java.lang.String appenderRef,
              java.lang.String key)

Method Detail

getNode

public Node getNode()

Returns the Dynamic Appender Node.

Returns:

The Node.

getAppenderRef

public java.lang.String getAppenderRef()

Returns the appender reference.

Returns:

The Appender reference.

getKey

public java.lang.String getKey()

Returns the key for this Route.

Returns:

the key for this Route.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createRoute

@PluginFactory
public static Route createRoute(@PluginAttribute("ref")
                                java.lang.String appenderRef,
                                @PluginAttribute("key")
                                java.lang.String key,
                                @PluginNode
                                Node node)

Create the Route.

Parameters:

appenderRef - The Appender reference.

key - The key.

node - The Node.

Returns:

A Route.