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, AppenderAdapter.Adapter, AsyncAppender, CountingNoOpAppender, FailoverAppender, HttpAppender, JeroMqAppender, JmsAppender, NullAppender, RewriteAppender, RoutingAppender, ScriptAppenderSelector, ServletAppender

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractAppender.Builder<B extends AbstractAppender.Builder<B>>	Subclasses can extend this abstract Builder.

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private ErrorHandler	handler
private boolean	ignoreExceptions
private Layout<? extends java.io.Serializable>	layout
private java.lang.String	name

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Appender

ELEMENT_TYPE, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout)	Deprecated. Use AbstractAppender(String, Filter, Layout, boolean, Property[]).
protected	AbstractAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions)	Deprecated. Use AbstractAppender(String, Filter, Layout, boolean, Property[])
protected	AbstractAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, Property[] properties)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	error(java.lang.String msg)	Handle an error with a message using the ErrorHandler configured for this Appender.
void	error(java.lang.String msg, java.lang.Throwable t)	Handle an error with a message and an exception using the ErrorHandler configured for this Appender.
void	error(java.lang.String msg, LogEvent event, java.lang.Throwable t)	Handle an error with a message, exception, and a logging event, using the ErrorHandler configured for this Appender.
ErrorHandler	getHandler()	Returns the ErrorHandler, if any.
Layout<? extends java.io.Serializable>	getLayout()	Returns the Layout for the appender.
java.lang.String	getName()	Returns the name of the Appender.
boolean	ignoreExceptions()	Some appenders need to propagate exceptions back to the application.
static int	parseInt(java.lang.String s, int defaultValue)
boolean	requiresLocation()
void	setHandler(ErrorHandler handler)	The handler must be set before the appender is started.
protected java.io.Serializable	toSerializable(LogEvent event)	Serializes the given event using the appender's layout if present.
java.lang.String	toString()

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, start, stop, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.Appender

append

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, start, stop

Field Detail

name

private final java.lang.String name

ignoreExceptions

private final boolean ignoreExceptions

layout

private final Layout<? extends java.io.Serializable> layout

handler

private ErrorHandler handler

Constructor Detail

AbstractAppender

@Deprecated
protected AbstractAppender(java.lang.String name,
                           Filter filter,
                           Layout<? extends java.io.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(java.lang.String name,
                           Filter filter,
                           Layout<? extends java.io.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(java.lang.String name,
                           Filter filter,
                           Layout<? extends java.io.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 Detail

parseInt

public static int parseInt(java.lang.String s,
                           int defaultValue)

requiresLocation

public boolean requiresLocation()

Specified by:

requiresLocation in interface LocationAware

error

public void error(java.lang.String msg)

Handle an error with a message using the ErrorHandler configured for this Appender.

Parameters:

msg - The message.

error

public void error(java.lang.String msg,
                  LogEvent event,
                  java.lang.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(java.lang.String msg,
                  java.lang.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 java.io.Serializable> getLayout()

Returns the Layout for the appender.

Specified by:

getLayout in interface Appender

Returns:

The Layout used to format the event.

getName

public java.lang.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 java.io.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object