org.apache.logging.log4j.core.appender

Class AbstractOutputStreamAppender<M extends OutputStreamManager>

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

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

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

org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<M>

Type Parameters:

M - The kind of OutputStreamManager under management

All Implemented Interfaces:

Appender, Filterable, LifeCycle, LifeCycle2

Direct Known Subclasses:

ConsoleAppender, FileAppender, MemoryMappedFileAppender, OutputStreamAppender, RandomAccessFileAppender, RollingFileAppender, RollingRandomAccessFileAppender, SocketAppender

public abstract class AbstractOutputStreamAppender<M extends OutputStreamManager>
extends AbstractAppender

Appends log events as bytes to a byte output stream. The stream encoding is defined in the layout.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractOutputStreamAppender.Builder<B extends AbstractOutputStreamAppender.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 and Description
private boolean	immediateFlush Immediate flush means that the underlying writer or output stream will be flushed at the end of each append operation.
private M	manager

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	AbstractOutputStreamAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager) Instantiates a WriterAppender and set the output destination to a new OutputStreamWriter initialized with os as its OutputStream.

Method Summary

Modifier and Type	Method and Description
void	append(LogEvent event) Actual writing occurs here.
protected void	directEncodeEvent(LogEvent event)
boolean	getImmediateFlush() Gets the immediate flush setting.
M	getManager() Gets the manager.
void	start() Make the Filter available for use.
boolean	stop(long timeout, java.util.concurrent.TimeUnit timeUnit) Cleanup the Filter.
protected boolean	stop(long timeout, java.util.concurrent.TimeUnit timeUnit, boolean changeLifeCycleState) Cleanup the Filter.
private void	tryAppend(LogEvent event)
protected void	writeByteArrayToManager(LogEvent event)

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

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.LifeCycle

getState, initialize, isStarted, isStopped, stop

Field Detail

immediateFlush

private final boolean immediateFlush

Immediate flush means that the underlying writer or output stream will be flushed at the end of each append operation. Immediate flush is slower but ensures that each append request is actually written. If immediateFlush is set to false, then there is a good chance that the last few logs events are not actually written to persistent media if and when the application crashes.

manager

private final M extends OutputStreamManager manager

Constructor Detail

AbstractOutputStreamAppender

protected AbstractOutputStreamAppender(java.lang.String name,
                                       Layout<? extends java.io.Serializable> layout,
                                       Filter filter,
                                       boolean ignoreExceptions,
                                       boolean immediateFlush,
                                       M manager)

Instantiates a WriterAppender and set the output destination to a new OutputStreamWriter initialized with os as its OutputStream.

Parameters:

name - The name of the Appender.

layout - The layout to format the message.

manager - The OutputStreamManager.

Method Detail

getImmediateFlush

public boolean getImmediateFlush()

Gets the immediate flush setting.

Returns:

immediate flush.

getManager

public M getManager()

Gets the manager.

Returns:

the manager.

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 boolean stop(long timeout,
                    java.util.concurrent.TimeUnit timeUnit)

Description copied from class: AbstractFilterable

Cleanup the Filter.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractFilterable

Parameters:

timeout - the maximum time to wait

timeUnit - the time unit of the timeout argument

Returns:

true if the receiver was stopped cleanly and normally, false otherwise.

stop

protected boolean stop(long timeout,
                       java.util.concurrent.TimeUnit timeUnit,
                       boolean changeLifeCycleState)

Description copied from class: AbstractFilterable

Cleanup the Filter.

Overrides:

stop in class AbstractFilterable

append

public void append(LogEvent event)

Actual writing occurs here.

Most subclasses of AbstractOutputStreamAppender will need to override this method.

Parameters:

event - The LogEvent.

tryAppend

private void tryAppend(LogEvent event)

directEncodeEvent

protected void directEncodeEvent(LogEvent event)

writeByteArrayToManager

protected void writeByteArrayToManager(LogEvent event)