Class FileAppender

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

org.apache.logging.log4j.core.appender.FileAppender

All Implemented Interfaces:

Appender, Filterable, LocationAware, LifeCycle, LifeCycle2

@Plugin(name="File",
        category="Core",
        elementType="appender",
        printObject=true)
public final class FileAppender
extends AbstractOutputStreamAppender<FileManager>

File Appender.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileAppender.Builder<B extends FileAppender.Builder<B>>	Builds FileAppender instances.

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private final Object	advertisement
private final Advertiser	advertiser
private static final int	DEFAULT_BUFFER_SIZE
private final String	fileName
static final String	PLUGIN_NAME

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	FileAppender(String name, Layout<? extends Serializable> layout, Filter filter, FileManager manager, String filename, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)

Method Summary

Modifier and Type	Method	Description
static <B extends FileAppender.Builder<B>> FileAppender	createAppender(String fileName, String append, String locking, String name, String immediateFlush, String ignoreExceptions, String bufferedIo, String bufferSizeStr, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseUri, Configuration config)	Deprecated. Use newBuilder()
String	getFileName()	Returns the file name this appender is associated with.
static <B extends FileAppender.Builder<B>> B	newBuilder()
boolean	stop(long timeout, TimeUnit timeUnit)	Cleanup the Filter.

Methods inherited from class AbstractOutputStreamAppender

append, directEncodeEvent, getImmediateFlush, getManager, start, 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

PLUGIN_NAME

public static final String PLUGIN_NAME

See Also:

• Constant Field Values

DEFAULT_BUFFER_SIZE

private static final int DEFAULT_BUFFER_SIZE

See Also:

• Constant Field Values

fileName

private final String fileName

advertiser

private final Advertiser advertiser

advertisement

private final Object advertisement

Constructor Details

FileAppender

private FileAppender(String name,
 Layout<? extends Serializable> layout,
 Filter filter,
 FileManager manager,
 String filename,
 boolean ignoreExceptions,
 boolean immediateFlush,
 Advertiser advertiser,
 Property[] properties)

Method Details

createAppender

@Deprecated
public static <B extends FileAppender.Builder<B>>
FileAppender createAppender(String fileName,
 String append,
 String locking,
 String name,
 String immediateFlush,
 String ignoreExceptions,
 String bufferedIo,
 String bufferSizeStr,
 Layout<? extends Serializable> layout,
 Filter filter,
 String advertise,
 String advertiseUri,
 Configuration config)

Deprecated.

Use newBuilder()

Create a File Appender.

Parameters:

fileName - The name and path of the file.

append - "True" if the file should be appended to, "false" if it should be overwritten. The default is "true".

locking - "True" if the file should be locked. The default is "false".

name - The name of the Appender.

immediateFlush - "true" if the contents should be flushed on every write, "false" otherwise. The default is "true".

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

bufferedIo - "true" if I/O should be buffered, "false" otherwise. The default is "true".

bufferSizeStr - buffer size for buffered IO (default is 8192).

layout - The layout to use to format the event. If no layout is provided the default PatternLayout will be used.

filter - The filter, if any, to use.

advertise - "true" if the appender configuration should be advertised, "false" otherwise.

advertiseUri - The advertised URI which can be used to retrieve the file contents.

config - The Configuration

Returns:

The FileAppender.

newBuilder

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

getFileName

public String getFileName()

Returns the file name this appender is associated with.

Returns:

The File name.

stop

public boolean stop(long timeout,
 TimeUnit timeUnit)

Description copied from class: AbstractFilterable

Cleanup the Filter.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractOutputStreamAppender<FileManager>

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.