Class OutputStreamAppender

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<OutputStreamManager>

org.apache.logging.log4j.core.appender.OutputStreamAppender

All Implemented Interfaces:

Appender, Filterable, LocationAware, LifeCycle, LifeCycle2

@Plugin(name="OutputStream",
        category="Core",
        elementType="appender",
        printObject=true)
public final class OutputStreamAppender
extends AbstractOutputStreamAppender<OutputStreamManager>

Appends log events to a given output stream using a layout.

Character encoding is handled within the Layout.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OutputStreamAppender.Builder<B extends OutputStreamAppender.Builder<B>>	Builds OutputStreamAppender instances.
private static class	OutputStreamAppender.FactoryData	Holds data to pass to factory method.
private static class	OutputStreamAppender.OutputStreamManagerFactory	Creates the manager.

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private static OutputStreamAppender.OutputStreamManagerFactory	factory

Fields inherited from class AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface Appender

ELEMENT_TYPE, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OutputStreamAppender(String name, Layout<? extends Serializable> layout, Filter filter, OutputStreamManager manager, boolean ignoreExceptions, Property[] properties)

Method Summary

Modifier and Type	Method	Description
static OutputStreamAppender	createAppender(Layout<? extends Serializable> layout, Filter filter, OutputStream target, String name, boolean follow, boolean ignore)	Creates an OutputStream Appender.
private static OutputStreamManager	getManager(OutputStream target, boolean follow, Layout<? extends Serializable> layout)
static <B extends OutputStreamAppender.Builder<B>> B	newBuilder()

Methods inherited from class AbstractOutputStreamAppender

append, directEncodeEvent, getImmediateFlush, getManager, start, stop, stop, writeByteArrayToManager

Methods inherited from class AbstractAppender

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

Methods inherited from class AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter

Methods inherited from class AbstractLifeCycle

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

Methods inherited from class Object

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

Methods inherited from interface LifeCycle

getState, initialize, isStarted, isStopped, stop

Field Details

factory

private static OutputStreamAppender.OutputStreamManagerFactory factory

Constructor Details

OutputStreamAppender

private OutputStreamAppender(String name,
 Layout<? extends Serializable> layout,
 Filter filter,
 OutputStreamManager manager,
 boolean ignoreExceptions,
 Property[] properties)

Method Details

createAppender

@PluginFactory
public static OutputStreamAppender createAppender(Layout<? extends Serializable> layout,
 Filter filter,
 OutputStream target,
 String name,
 boolean follow,
 boolean ignore)

Creates an OutputStream Appender.

Parameters:

layout - The layout to use or null to get the default layout.

filter - The Filter or null.

target - an output stream.

name - The name of the Appender (required).

follow - If true will follow changes to the underlying output stream. Use false as the default.

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

Returns:

The ConsoleAppender.

getManager

private static OutputStreamManager getManager(OutputStream target,
 boolean follow,
 Layout<? extends Serializable> layout)

newBuilder

@PluginBuilderFactory
public static <B extends OutputStreamAppender.Builder<B>>
B newBuilder()