org.apache.logging.log4j.core.appender

Class RollingRandomAccessFileAppender

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

org.apache.logging.log4j.core.appender.RollingRandomAccessFileAppender

All Implemented Interfaces:

Appender, Filterable, LifeCycle, LifeCycle2

@Plugin(name="RollingRandomAccessFile",
        category="Core",
        elementType="appender",
        printObject=true)
public final class RollingRandomAccessFileAppender
extends AbstractOutputStreamAppender<RollingRandomAccessFileManager>

An appender that writes to random access files and can roll over at intervals.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RollingRandomAccessFileAppender.Builder<B extends RollingRandomAccessFileAppender.Builder<B>>

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

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	advertisement
private Advertiser	advertiser
private java.lang.String	fileName
private java.lang.String	filePattern

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
private	RollingRandomAccessFileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, RollingRandomAccessFileManager manager, java.lang.String fileName, java.lang.String filePattern, boolean ignoreExceptions, boolean immediateFlush, int bufferSize, Advertiser advertiser)

Method Summary

Modifier and Type	Method and Description
void	append(LogEvent event) Write the log entry rolling over the file when required.
static <B extends RollingRandomAccessFileAppender.Builder<B>> RollingRandomAccessFileAppender	createAppender(java.lang.String fileName, java.lang.String filePattern, java.lang.String append, java.lang.String name, java.lang.String immediateFlush, java.lang.String bufferSizeStr, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends java.io.Serializable> layout, Filter filter, java.lang.String ignoreExceptions, java.lang.String advertise, java.lang.String advertiseURI, Configuration configuration) Deprecated. Use newBuilder().
int	getBufferSize() Returns the size of the file manager's buffer.
java.lang.String	getFileName() Returns the File name for the Appender.
java.lang.String	getFilePattern() Returns the file pattern used when rolling over.
static <B extends RollingRandomAccessFileAppender.Builder<B>> B	newBuilder()
boolean	stop(long timeout, java.util.concurrent.TimeUnit timeUnit) Cleanup the Filter.

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

directEncodeEvent, getImmediateFlush, getManager, start, stop, writeByteArrayToManager

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

fileName

private final java.lang.String fileName

filePattern

private final java.lang.String filePattern

advertisement

private final java.lang.Object advertisement

advertiser

private final Advertiser advertiser

Constructor Detail

RollingRandomAccessFileAppender

private RollingRandomAccessFileAppender(java.lang.String name,
                                        Layout<? extends java.io.Serializable> layout,
                                        Filter filter,
                                        RollingRandomAccessFileManager manager,
                                        java.lang.String fileName,
                                        java.lang.String filePattern,
                                        boolean ignoreExceptions,
                                        boolean immediateFlush,
                                        int bufferSize,
                                        Advertiser advertiser)

Method Detail

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 AbstractOutputStreamAppender<RollingRandomAccessFileManager>

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.

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

Parameters:

event - The LogEvent.

getFileName

public java.lang.String getFileName()

Returns the File name for the Appender.

Returns:

The file name.

getFilePattern

public java.lang.String getFilePattern()

Returns the file pattern used when rolling over.

Returns:

The file pattern.

getBufferSize

public int getBufferSize()

Returns the size of the file manager's buffer.

Returns:

the buffer size

createAppender

@Deprecated
public static <B extends RollingRandomAccessFileAppender.Builder<B>> RollingRandomAccessFileAppender createAppender(java.lang.String fileName,
                                                                                                                                java.lang.String filePattern,
                                                                                                                                java.lang.String append,
                                                                                                                                java.lang.String name,
                                                                                                                                java.lang.String immediateFlush,
                                                                                                                                java.lang.String bufferSizeStr,
                                                                                                                                TriggeringPolicy policy,
                                                                                                                                RolloverStrategy strategy,
                                                                                                                                Layout<? extends java.io.Serializable> layout,
                                                                                                                                Filter filter,
                                                                                                                                java.lang.String ignoreExceptions,
                                                                                                                                java.lang.String advertise,
                                                                                                                                java.lang.String advertiseURI,
                                                                                                                                Configuration configuration)

Deprecated. Use newBuilder().

Create a RollingRandomAccessFileAppender.

Parameters:

fileName - The name of the file that is actively written to. (required).

filePattern - The pattern of the file name to use on rollover. (required).

append - If true, events are appended to the file. If false, the file is overwritten when opened. Defaults to "true"

name - The name of the Appender (required).

immediateFlush - When true, events are immediately flushed. Defaults to "true".

bufferSizeStr - The buffer size, defaults to .

policy - The triggering policy. (required).

strategy - The rollover strategy. Defaults to DefaultRolloverStrategy.

layout - The layout to use (defaults to the default PatternLayout).

filter - The Filter or null.

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

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

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

configuration - The Configuration.

Returns:

A RollingRandomAccessFileAppender.

newBuilder

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