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

• stop

  public void stop()

  Description copied from class: AbstractFilterable
  Cleanup the Filter.

  Specified by:

  stop in interface LifeCycle

  Overrides:

  stop in class AbstractFilterable

• append

  public void append(LogEvent logEvent)

  Actual writing occurs here.

  Parameters:

  logEvent - The LogEvent.

• createAppender

  @PluginFactory
  public static AsyncAppender createAppender(@PluginElement(value="AppenderRef")
                                           AppenderRef[] appenderRefs,
                                           @PluginAttribute(value="errorRef")@PluginAliases(value="error-ref")
                                           String errorRef,
                                           @PluginAttribute(value="blocking",defaultBoolean=true)
                                           boolean blocking,
                                           @PluginAttribute(value="shutdownTimeout",defaultLong=0L)
                                           long shutdownTimeout,
                                           @PluginAttribute(value="bufferSize",defaultInt=128)
                                           int size,
                                           @PluginAttribute(value="name")
                                           String name,
                                           @PluginAttribute(value="includeLocation",defaultBoolean=false)
                                           boolean includeLocation,
                                           @PluginElement(value="Filter")
                                           Filter filter,
                                           @PluginConfiguration
                                           Configuration config,
                                           @PluginAttribute(value="ignoreExceptions",defaultBoolean=true)
                                           boolean ignoreExceptions)

  Create an AsyncAppender.

  Parameters:

  appenderRefs - The Appenders to reference.

  errorRef - An optional Appender to write to if the queue is full or other errors occur.

  blocking - True if the Appender should wait when the queue is full. The default is true.

  shutdownTimeout - How many milliseconds the Appender should wait to flush outstanding log events in the queue on shutdown. The default is zero which means to wait forever.

  size - The size of the event queue. The default is 128.

  name - The name of the Appender.

  includeLocation - whether to include location information. The default is false.

  filter - The Filter or null.

  config - The Configuration.

  ignoreExceptions - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.

  Returns:

  The AsyncAppender.

• getAppenderRefStrings

  public String[] getAppenderRefStrings()

  Returns the names of the appenders that this asyncAppender delegates to as an array of Strings.

  Returns:

  the names of the sink appenders

• isIncludeLocation

  public boolean isIncludeLocation()

  Returns true if this AsyncAppender will take a snapshot of the stack with every log event to determine the class and method where the logging call was made.

  Returns:

  true if location is included with every event, false otherwise

• isBlocking

  public boolean isBlocking()

  Returns true if this AsyncAppender will block when the queue is full, or false if events are dropped when the queue is full.

  Returns:

  whether this AsyncAppender will block or drop events when the queue is full.

• getErrorRef

  public String getErrorRef()

  Returns the name of the appender that any errors are logged to or null.

  Returns:

  the name of the appender that any errors are logged to or null

• getQueueCapacity

  public int getQueueCapacity()

• getQueueRemainingCapacity

  public int getQueueRemainingCapacity()