com.kdgregory.log4j2.aws.internal

Class AbstractAppender<WriterConfigType extends AbstractWriterConfig<WriterConfigType>,AppenderConfigType extends AbstractAppenderConfig,AppenderStatsType extends AbstractWriterStatistics,AppenderStatsMXBeanType>

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

com.kdgregory.log4j2.aws.internal.AbstractAppender<WriterConfigType,AppenderConfigType,AppenderStatsType,AppenderStatsMXBeanType>

All Implemented Interfaces:

org.apache.logging.log4j.core.Appender, org.apache.logging.log4j.core.filter.Filterable, org.apache.logging.log4j.core.LifeCycle, org.apache.logging.log4j.core.LifeCycle2

Direct Known Subclasses:

CloudWatchAppender, KinesisAppender, SNSAppender

public abstract class AbstractAppender<WriterConfigType extends AbstractWriterConfig<WriterConfigType>,AppenderConfigType extends AbstractAppenderConfig,AppenderStatsType extends AbstractWriterStatistics,AppenderStatsMXBeanType>
extends org.apache.logging.log4j.core.appender.AbstractAppender

Common implementation code that's shared between appenders.

For the most part, appenders have the same behavior: they initialize, transform log messages, and shut down. Most of the code to do that lives here, with a few hooks that are implemented in the appender proper.

Most of the member variables defined by this class are protected. This is intended to support testing. If you decide to subclass and access those variables, remember that this is an internal class: they may go away.

Log4J2, like Logback, explicitly initializes the appender before use. The only strangeness here is in stop(): there are two versions defined by the interface, but current versions of Log4J call only one of them.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B extends org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B>>

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

org.apache.logging.log4j.core.LifeCycle.State

Field Summary

Fields

Modifier and Type	Field and Description
protected AppenderConfigType	appenderConfig
protected AppenderStatsType	appenderStats
protected MessageQueue.DiscardAction	discardAction
protected InternalLogger	internalLogger
protected Charset	layoutCharset
protected ThreadFactory	threadFactory
protected LogWriter	writer
protected WriterFactory<WriterConfigType,AppenderStatsType>	writerFactory

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAppender(String name, ThreadFactory threadFactory, WriterFactory<WriterConfigType,AppenderStatsType> writerFactory, AppenderStatsType appenderStats, Class<AppenderStatsMXBeanType> appenderStatsMXBeanClass, AppenderConfigType config, InternalLogger providedInternalLogger)

Method Summary

Modifier and Type	Method and Description
void	append(org.apache.logging.log4j.core.LogEvent event)
protected abstract WriterConfigType	generateWriterConfig() Called as part of initialization.
AppenderStatsType	getAppenderStatistics() Returns the appender statistics object.
AppenderConfigType	getConfig() Exposes configuration for testing.
protected void	registerStatisticsBean() Registers the appender statistics with JMX.
void	start()
void	stop()
boolean	stop(long timeout, TimeUnit timeUnit)
protected void	unregisterStatisticsBean() Unregisters the appender statistics from JMX.

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toString

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

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, 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.LifeCycle

getState, initialize, isStarted, isStopped

Field Detail

threadFactory

protected ThreadFactory threadFactory

writerFactory

protected WriterFactory<WriterConfigType extends AbstractWriterConfig<WriterConfigType>,AppenderStatsType extends AbstractWriterStatistics> writerFactory

internalLogger

protected InternalLogger internalLogger

appenderStats

protected AppenderStatsType extends AbstractWriterStatistics appenderStats

appenderConfig

protected AppenderConfigType extends AbstractAppenderConfig appenderConfig

layoutCharset

protected Charset layoutCharset

discardAction

protected MessageQueue.DiscardAction discardAction

writer

protected volatile LogWriter writer

Constructor Detail

AbstractAppender

protected AbstractAppender(String name,
                           ThreadFactory threadFactory,
                           WriterFactory<WriterConfigType,AppenderStatsType> writerFactory,
                           AppenderStatsType appenderStats,
                           Class<AppenderStatsMXBeanType> appenderStatsMXBeanClass,
                           AppenderConfigType config,
                           InternalLogger providedInternalLogger)

Method Detail

getAppenderStatistics

public AppenderStatsType getAppenderStatistics()

Returns the appender statistics object.

getConfig

public AppenderConfigType getConfig()

Exposes configuration for testing.

start

public void start()

Specified by:

start in interface org.apache.logging.log4j.core.LifeCycle

Overrides:

start in class org.apache.logging.log4j.core.filter.AbstractFilterable

stop

public void stop()

Specified by:

stop in interface org.apache.logging.log4j.core.LifeCycle

Overrides:

stop in class org.apache.logging.log4j.core.AbstractLifeCycle

stop

public boolean stop(long timeout,
                    TimeUnit timeUnit)

Specified by:

stop in interface org.apache.logging.log4j.core.LifeCycle2

Overrides:

stop in class org.apache.logging.log4j.core.filter.AbstractFilterable

append

public void append(org.apache.logging.log4j.core.LogEvent event)

generateWriterConfig

protected abstract WriterConfigType generateWriterConfig()

Called as part of initialization. Subclass should provide a config object that is populated with everything the subclass controls, and with all substitutions applied. The abstract class will populate with everything that it controls (eg, connection info).

registerStatisticsBean

protected void registerStatisticsBean()

Registers the appender statistics with JMX. Logs but otherwise ignores failure.

The name for the bean is consistent with the Log4J LayoutDynamicMBean, so that it will appear in the hierarchy under the appender.

unregisterStatisticsBean

protected void unregisterStatisticsBean()

Unregisters the appender statistics from JMX. This is called when the appender is closed. Logs but otherwise ignores failure.