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

Class AbstractAppender

java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
All Implemented Interfaces:
Appender, Filterable, LocationAware, LifeCycle, LifeCycle2
Direct Known Subclasses:
AbstractDatabaseAppender, AbstractOutputStreamAppender, AbstractWriterAppender, AsyncAppender, CountingNoOpAppender, FailoverAppender, HttpAppender, JeroMqAppender, JmsAppender, KafkaAppender, NullAppender, RewriteAppender, RoutingAppender, ScriptAppenderSelector, SmtpAppender
public abstract class AbstractAppender extends AbstractFilterable implements Appender, LocationAware
Abstract base class for Appenders. Although Appenders do not have to extend this class, doing so will simplify their implementation.

  • Constructor Details

    • AbstractAppender

      @Deprecated protected AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout)
      Deprecated.
      Use AbstractAppender(String, Filter, Layout, boolean, Property[]).
      Constructor that defaults to suppressing exceptions.
      Parameters:
      name - The Appender name.
      filter - The Filter to associate with the Appender.
      layout - The layout to use to format the event.

    • AbstractAppender

      @Deprecated protected AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions)
      Deprecated.
      Use AbstractAppender(String, Filter, Layout, boolean, Property[])
      Constructor.
      Parameters:
      name - The Appender name.
      filter - The Filter to associate with the Appender.
      layout - The layout to use to format the event.
      ignoreExceptions - If true, exceptions will be logged and suppressed. If false errors will be logged and then passed to the application.

    • AbstractAppender

      protected AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties)
      Constructor.
      Parameters:
      name - The Appender name.
      filter - The Filter to associate with the Appender.
      layout - The layout to use to format the event.
      ignoreExceptions - If true, exceptions will be logged and suppressed. If false errors will be logged and then passed to the application.
      Since:
      2.11.2

  • Method Details

    • parseInt

      public static int parseInt(String s, int defaultValue)

    • requiresLocation

      public boolean requiresLocation()
      Specified by:
      requiresLocation in interface LocationAware

    • error

      public void error(String msg)
      Handle an error with a message using the ErrorHandler configured for this Appender.
      Parameters:
      msg - The message.

    • error

      public void error(String msg, LogEvent event, Throwable t)
      Handle an error with a message, exception, and a logging event, using the ErrorHandler configured for this Appender.
      Parameters:
      msg - The message.
      event - The LogEvent.
      t - The Throwable.

    • error

      public void error(String msg, Throwable t)
      Handle an error with a message and an exception using the ErrorHandler configured for this Appender.
      Parameters:
      msg - The message.
      t - The Throwable.

    • getHandler

      public ErrorHandler getHandler()
      Returns the ErrorHandler, if any.
      Specified by:
      getHandler in interface Appender
      Returns:
      The ErrorHandler.

    • getLayout

      public Layout<? extends Serializable> getLayout()
      Returns the Layout for the appender.
      Specified by:
      getLayout in interface Appender
      Returns:
      The Layout used to format the event.

    • getName

      public String getName()
      Returns the name of the Appender.
      Specified by:
      getName in interface Appender
      Returns:
      The name of the Appender.

    • ignoreExceptions

      public boolean ignoreExceptions()
      Some appenders need to propagate exceptions back to the application. When ignoreExceptions is false the AppenderControl will allow the exception to percolate.
      Specified by:
      ignoreExceptions in interface Appender
      Returns:
      true if exceptions will be logged but now thrown, false otherwise.

    • setHandler

      public void setHandler(ErrorHandler handler)
      The handler must be set before the appender is started.
      Specified by:
      setHandler in interface Appender
      Parameters:
      handler - The ErrorHandler to use.

    • toSerializable

      protected Serializable toSerializable(LogEvent event)
      Serializes the given event using the appender's layout if present.
      Parameters:
      event - the event to serialize.
      Returns:
      the serialized event or null if no layout is present.

    • toString

      public String toString()
      Overrides:
      toString in class Object