Module ch.qos.logback.core

Package ch.qos.logback.core

Class AppenderBase<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.AppenderBase<E>

All Implemented Interfaces:

Appender<E>, ContextAware, FilterAttachable<E>, LifeCycle

Direct Known Subclasses:

AbstractSocketAppender, CyclicBufferAppender, ListAppender, NOPAppender, NPEAppender, SiftingAppenderBase, SMTPAppenderBase, StringListAppender, SyslogAppenderBase, WithLayoutListAppender

public abstract class AppenderBase<E>
extends ContextAwareBase
implements Appender<E>

Sets a skeleton implementation for appenders.

It is coarsely synchronized in its #doAppend(E) method.

For more information about this appender, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#AppenderBase

Author:

Ceki Gülcü

Field Summary

Fields

Modifier and Type	Field	Description
protected String	name	Appenders are named.
protected boolean	started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
AppenderBase()

Method Summary

Modifier and Type	Method	Description
void	addFilter(Filter<E> newFilter)	Add a filter.
protected abstract void	append(E eventObject)
void	clearAllFilters()
void	doAppend(E eventObject)	This is where an appender accomplishes its work: format and deliver the provided event to the appender's destination.
List<Filter<E>>	getCopyOfAttachedFiltersList()	Get a copy of all the filters contained within this FilterAttachable object.
FilterReply	getFilterChainDecision(E event)	Loop through the filters in the chain.
String	getName()	Get the name of this appender.
boolean	isStarted()
void	setName(String name)	Set the name of this appender.
void	start()
void	stop()
String	toString()

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

started

protected volatile boolean started

name

protected String name

Appenders are named.

Constructor Detail

AppenderBase

public AppenderBase()

Method Detail

getName

public String getName()

Description copied from interface: Appender

Get the name of this appender. The name uniquely identifies the appender within its context and is used for configuration and lookup.

Specified by:

getName in interface Appender<E>

Returns:

the appender name, or null if not set

doAppend

public void doAppend(E eventObject)

Description copied from interface: Appender

This is where an appender accomplishes its work: format and deliver the provided event to the appender's destination.

Implementations should apply any configured filters before outputting the event. Implementations should avoid throwing runtime exceptions; if an error occurs that cannot be handled internally, a LogbackException (or a subtype) may be thrown to indicate a failure during append.

Specified by:

doAppend in interface Appender<E>

Parameters:

eventObject - the event to append; may not be null

append

protected abstract void append(E eventObject)

setName

public void setName(String name)

Set the name of this appender.

Specified by:

setName in interface Appender<E>

Parameters:

name - the new name for this appender; may be null to unset

start

public void start()

Specified by:

start in interface LifeCycle

stop

public void stop()

Specified by:

stop in interface LifeCycle

isStarted

public boolean isStarted()

Specified by:

isStarted in interface LifeCycle

toString

public String toString()

Overrides:

toString in class Object

addFilter

public void addFilter(Filter<E> newFilter)

Description copied from interface: FilterAttachable

Add a filter.

Specified by:

addFilter in interface FilterAttachable<E>

clearAllFilters

public void clearAllFilters()

Specified by:

clearAllFilters in interface FilterAttachable<E>

getCopyOfAttachedFiltersList

public List<Filter<E>> getCopyOfAttachedFiltersList()

Description copied from interface: FilterAttachable

Get a copy of all the filters contained within this FilterAttachable object.

Specified by:

getCopyOfAttachedFiltersList in interface FilterAttachable<E>

Returns:

all attached filters as a list

getFilterChainDecision

public FilterReply getFilterChainDecision(E event)

Description copied from interface: FilterAttachable

Loop through the filters in the chain. As soon as a filter decides on ACCEPT or DENY, then that value is returned. If all of the filters return NEUTRAL, then NEUTRAL is returned.

Specified by:

getFilterChainDecision in interface FilterAttachable<E>