org.apache.logging.log4j.core.appender
Class FailoverAppender

java.lang.Object
  extended by org.apache.logging.log4j.core.AbstractLifeCycle
      extended by org.apache.logging.log4j.core.filter.AbstractFilterable
          extended by org.apache.logging.log4j.core.appender.AbstractAppender
              extended by org.apache.logging.log4j.core.appender.FailoverAppender
All Implemented Interfaces:
Serializable, Appender, Filterable, LifeCycle

@Plugin(name="Failover",
        category="Core",
        elementType="appender",
        printObject=true)
public final class FailoverAppender
extends AbstractAppender

The FailoverAppender will capture exceptions in an Appender and then route the event to a different appender. Hopefully it is obvious that the Appenders must be configured to not suppress exceptions for the FailoverAppender to work.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
 
Field Summary
 
Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
LOGGER
 
Method Summary
 void append(LogEvent event)
          Handle the Log event.
static FailoverAppender createAppender(String name, String primary, String[] failovers, String retryIntervalSeconds, Configuration config, Filter filter, String ignore)
          Create a Failover Appender.
 void start()
          Make the Filter available for use.
 String toString()
           
 
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler
 
Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, hasFilter, isFiltered, removeFilter, stop
 
Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
equals, getState, hashCode, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.logging.log4j.core.LifeCycle
isStarted, isStopped, stop
 

Method Detail

start

public void start()
Description copied from class: AbstractFilterable
Make the Filter available for use.

Specified by:
start in interface LifeCycle
Overrides:
start in class AbstractFilterable

append

public void append(LogEvent event)
Handle the Log event.

Parameters:
event - The LogEvent.

toString

public String toString()
Overrides:
toString in class AbstractAppender

createAppender

@PluginFactory
public static FailoverAppender createAppender(@PluginAttribute(value="name")
                                                            String name,
                                                            @PluginAttribute(value="primary")
                                                            String primary,
                                                            @PluginElement(value="Failovers")
                                                            String[] failovers,
                                                            @PluginAliases(value="retryInterval")@PluginAttribute(value="retryIntervalSeconds")
                                                            String retryIntervalSeconds,
                                                            @PluginConfiguration
                                                            Configuration config,
                                                            @PluginElement(value="Filter")
                                                            Filter filter,
                                                            @PluginAttribute(value="ignoreExceptions")
                                                            String ignore)
Create a Failover Appender.

Parameters:
name - The name of the Appender (required).
primary - The name of the primary Appender (required).
failovers - The name of one or more Appenders to fail over to (at least one is required).
retryIntervalSeconds - The retry interval in seconds.
config - The current Configuration (passed by the Configuration when the appender is created).
filter - A Filter (optional).
ignore - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.
Returns:
The FailoverAppender that was created.


Copyright © 1999-2014 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.