org.apache.logging.log4j.core.appender
Class RandomAccessFileAppender

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<RandomAccessFileManager>
                  org.apache.logging.log4j.core.appender.RandomAccessFileAppender

All Implemented Interfaces:

Serializable, Appender, Filterable, LifeCycle

@Plugin(name="RandomAccessFile",
        category="Core",
        elementType="appender",
        printObject=true)
public final class RandomAccessFileAppender
extends AbstractOutputStreamAppender<RandomAccessFileManager>

File Appender.

See Also:

Serialized Form

Nested Class Summary

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

LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender

immediateFlush

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

LOGGER

Method Summary

void	append(LogEvent event) Write the log entry rolling over the file when required.
static RandomAccessFileAppender	createAppender(String fileName, String append, String name, String immediateFlush, String bufferSizeStr, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseURI, Configuration config) Create a File Appender.
int	getBufferSize() Returns the size of the file manager's buffer.
String	getFileName() Returns the file name this appender is associated with.
void	stop() Cleanup the Filter.

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

getManager, start

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, hashCodeImpl, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping

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, isStarted, isStopped

Method Detail

stop

public void stop()

Description copied from class: AbstractFilterable

Cleanup the Filter.

Specified by:

stop in interface LifeCycle

Overrides:

stop in class AbstractOutputStreamAppender<RandomAccessFileManager>

append

public void append(LogEvent event)

Write the log entry rolling over the file when required.

Specified by:

append in interface Appender

Overrides:

append in class AbstractOutputStreamAppender<RandomAccessFileManager>

Parameters:

event - The LogEvent.

getFileName

public String getFileName()

Returns the file name this appender is associated with.

Returns:

The File name.

getBufferSize

public int getBufferSize()

Returns the size of the file manager's buffer.

Returns:

the buffer size

createAppender

@PluginFactory
public static RandomAccessFileAppender createAppender(@PluginAttribute(value="fileName")
                                                                    String fileName,
                                                                    @PluginAttribute(value="append")
                                                                    String append,
                                                                    @PluginAttribute(value="name")
                                                                    String name,
                                                                    @PluginAttribute(value="immediateFlush")
                                                                    String immediateFlush,
                                                                    @PluginAttribute(value="bufferSize")
                                                                    String bufferSizeStr,
                                                                    @PluginAttribute(value="ignoreExceptions")
                                                                    String ignore,
                                                                    @PluginElement(value="Layout")
                                                                    Layout<? extends Serializable> layout,
                                                                    @PluginElement(value="Filter")
                                                                    Filter filter,
                                                                    @PluginAttribute(value="advertise")
                                                                    String advertise,
                                                                    @PluginAttribute(value="advertiseURI")
                                                                    String advertiseURI,
                                                                    @PluginConfiguration
                                                                    Configuration config)

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

name - The name of the Appender.

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

bufferSizeStr - The buffer size, defaults to .

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

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.