Class 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 org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
-
Field Summary
Fields Modifier and Type Field Description static String
PLUGIN_NAME
-
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
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <B extends FileAppender.Builder<B>>
FileAppendercreateAppender(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.UsenewBuilder()
String
getFileName()
Returns the file name this appender is associated with.static <B extends FileAppender.Builder<B>>
BnewBuilder()
boolean
stop(long timeout, TimeUnit timeUnit)
Cleanup the Filter.-
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender
append, 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, requiresLocation, setHandler, toSerializable, toString
-
Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, getPropertyArray, 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
-
-
-
-
Field Detail
-
PLUGIN_NAME
public static final String PLUGIN_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
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.UsenewBuilder()
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 interfaceLifeCycle2
- Overrides:
stop
in classAbstractOutputStreamAppender<FileManager>
- Parameters:
timeout
- the maximum time to waittimeUnit
- the time unit of the timeout argument- Returns:
- true if the receiver was stopped cleanly and normally, false otherwise.
-
-