org.rvpf.base.logger.log4j

Class DetailFileAppender

Object

AbstractLifeCycle

AbstractFilterable

AbstractAppender

AbstractOutputStreamAppender<DetailFileManager>

DetailFileAppender

All Implemented Interfaces:

Appender, Filterable, LifeCycle, LifeCycle2

@Plugin(name="DetailFile",
        category="Core",
        elementType="appender",
        printObject=true)
public final class DetailFileAppender
extends AbstractOutputStreamAppender<DetailFileManager>

Detail file appender.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractOutputStreamAppender

AbstractOutputStreamAppender.Builder<B extends AbstractOutputStreamAppender.Builder<B>>

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_BACKUPS_PROPERTY Specifies the number of backup log files.
static String	LOG_PREFIX_PROPERTY Specifies the log file prefix.
static String	LOG_SIZE_PROPERTY Specifies the log file size.

Fields inherited from class AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface Appender

ELEMENT_TYPE

Method Summary

Modifier and Type	Method and Description
void	append(LogEvent event)
static DetailFileAppender	createAppender(String name, String directory, String fileNamePrefix, String fileNameSuffix, String maxFileSize, int maxBackups, boolean locking, boolean immediateFlush, boolean bufferedIo, int bufferSize, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions) Creates a detail file appender.

Methods inherited from class AbstractOutputStreamAppender

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

Methods inherited from class AbstractAppender

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

Methods inherited from class AbstractFilterable

addFilter, getFilter, 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 Detail

LOG_BACKUPS_PROPERTY

public static final String LOG_BACKUPS_PROPERTY

Specifies the number of backup log files.

See Also:

Constant Field Values

LOG_PREFIX_PROPERTY

public static final String LOG_PREFIX_PROPERTY

Specifies the log file prefix.

See Also:

Constant Field Values

LOG_SIZE_PROPERTY

public static final String LOG_SIZE_PROPERTY

Specifies the log file size.

See Also:

Constant Field Values

Method Detail

createAppender

@PluginFactory
public static DetailFileAppender createAppender(@PluginAttribute(value="name")
                                                                String name,
                                                                @PluginAttribute(value="directory",defaultString=".")
                                                                String directory,
                                                                @PluginAttribute(value="fileNamePrefix")
                                                                String fileNamePrefix,
                                                                @PluginAttribute(value="fileNameSuffix",defaultString=".log")
                                                                String fileNameSuffix,
                                                                @PluginAttribute(value="maxFileSize",defaultString="0")
                                                                String maxFileSize,
                                                                @PluginAttribute(value="maxBackups",defaultInt=1)
                                                                int maxBackups,
                                                                @PluginAttribute(value="locking",defaultBoolean=false)
                                                                boolean locking,
                                                                @PluginAttribute(value="immediateFlush",defaultBoolean=true)
                                                                boolean immediateFlush,
                                                                @PluginAttribute(value="bufferedIo",defaultBoolean=true)
                                                                boolean bufferedIo,
                                                                @PluginAttribute(value="bufferSize",defaultInt=8192)
                                                                int bufferSize,
                                                                @PluginElement(value="Filter")
                                                                Filter filter,
                                                                @PluginElement(value="Layout")
                                                                Layout<? extends Serializable> layout,
                                                                @PluginAttribute(value="ignoreExceptions",defaultBoolean=true)
                                                                boolean ignoreExceptions)

Creates a detail file appender.

Parameters:

name - The name of the appender.

directory - The log file directory.

fileNamePrefix - The log file name prefix.

fileNameSuffix - The log file name suffix.

maxFileSize - The maximum file size.

maxBackups - The maximum number of backup files.

locking - True if the file should be locked.

immediateFlush - True to flush on every write.

bufferedIo - True if I/O should be buffered.

bufferSize - Buffer size for buffered IO.

layout - The layout or null.

filter - The filter or null.

ignoreExceptions - True ignores exceptions.

Returns:

the new detail file appender.

append

public void append(LogEvent event)

Specified by:

append in interface Appender

Overrides:

append in class AbstractOutputStreamAppender<DetailFileManager>