Class MemoryMappedFileAppender

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

org.apache.logging.log4j.core.appender.MemoryMappedFileAppender

All Implemented Interfaces:

Appender, Filterable, LocationAware, LifeCycle, LifeCycle2

@Plugin(name="MemoryMappedFile",
        category="Core",
        elementType="appender",
        printObject=true)
public final class MemoryMappedFileAppender
extends AbstractOutputStreamAppender<MemoryMappedFileManager>

Memory Mapped File Appender.

Since:

2.1

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private Object	advertisement
private final Advertiser	advertiser
private static final int	BIT_POSITION_1GB
private final String	fileName
private static final int	MAX_REGION_LENGTH
private static final int	MIN_REGION_LENGTH

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

Method Summary

Modifier and Type	Method	Description
static <B extends MemoryMappedFileAppender.Builder<B>> MemoryMappedFileAppender	createAppender(String fileName, String append, String name, String immediateFlush, String regionLengthStr, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseURI, Configuration config)	Deprecated. Use newBuilder().
private static int	determineValidRegionLength(String name, int regionLength)	Converts the specified region length to a valid value.
String	getFileName()	Returns the file name this appender is associated with.
int	getRegionLength()	Returns the length of the memory mapped region.
static <B extends MemoryMappedFileAppender.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

BIT_POSITION_1GB

private static final int BIT_POSITION_1GB

See Also:

• Constant Field Values

MAX_REGION_LENGTH

private static final int MAX_REGION_LENGTH

See Also:

• Constant Field Values

MIN_REGION_LENGTH

private static final int MIN_REGION_LENGTH

See Also:

• Constant Field Values

fileName

private final String fileName

advertisement

private Object advertisement

advertiser

private final Advertiser advertiser

Constructor Details

MemoryMappedFileAppender

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

Method Details

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

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.

getFileName

public String getFileName()

Returns the file name this appender is associated with.

Returns:

The File name.

getRegionLength

public int getRegionLength()

Returns the length of the memory mapped region.

Returns:

the length of the memory mapped region

createAppender

@Deprecated
public static <B extends MemoryMappedFileAppender.Builder<B>>
MemoryMappedFileAppender createAppender(String fileName,
 String append,
 String name,
 String immediateFlush,
 String regionLengthStr,
 String ignore,
 Layout<? extends Serializable> layout,
 Filter filter,
 String advertise,
 String advertiseURI,
 Configuration config)

Deprecated.

Use newBuilder().

Create a Memory Mapped 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 "false".

regionLengthStr - The buffer size, defaults to 33554432.

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.

newBuilder

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

determineValidRegionLength

private static int determineValidRegionLength(String name,
 int regionLength)

Converts the specified region length to a valid value.