@Plugin(name="File", category="Core", elementType="appender", printObject=true) public final class FileAppender extends AbstractOutputStreamAppender<FileManager>
Modifier and Type | Class and Description |
---|---|
static class |
FileAppender.Builder<B extends FileAppender.Builder<B>>
Builds FileAppender instances.
|
LifeCycle.State
Modifier and Type | Field and Description |
---|---|
private java.lang.Object |
advertisement |
private Advertiser |
advertiser |
private static int |
DEFAULT_BUFFER_SIZE |
private java.lang.String |
fileName |
static java.lang.String |
PLUGIN_NAME |
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
ELEMENT_TYPE
Modifier | Constructor and Description |
---|---|
private |
FileAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
FileManager manager,
java.lang.String filename,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser) |
Modifier and Type | Method and Description |
---|---|
static <B extends FileAppender.Builder<B>> |
createAppender(java.lang.String fileName,
java.lang.String append,
java.lang.String locking,
java.lang.String name,
java.lang.String immediateFlush,
java.lang.String ignoreExceptions,
java.lang.String bufferedIo,
java.lang.String bufferSizeStr,
Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String advertise,
java.lang.String advertiseUri,
Configuration config)
Deprecated.
Use
newBuilder() |
java.lang.String |
getFileName()
Returns the file name this appender is associated with.
|
static <B extends FileAppender.Builder<B>> |
newBuilder() |
boolean |
stop(long timeout,
java.util.concurrent.TimeUnit timeUnit)
Cleanup the Filter.
|
append, directEncodeEvent, getImmediateFlush, getManager, start, stop, writeByteArrayToManager
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toString
addFilter, getFilter, hasFilter, isFiltered, removeFilter
equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop
public static final java.lang.String PLUGIN_NAME
private static final int DEFAULT_BUFFER_SIZE
private final java.lang.String fileName
private final Advertiser advertiser
private final java.lang.Object advertisement
private FileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, FileManager manager, java.lang.String filename, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser)
@Deprecated public static <B extends FileAppender.Builder<B>> FileAppender createAppender(java.lang.String fileName, java.lang.String append, java.lang.String locking, java.lang.String name, java.lang.String immediateFlush, java.lang.String ignoreExceptions, java.lang.String bufferedIo, java.lang.String bufferSizeStr, Layout<? extends java.io.Serializable> layout, Filter filter, java.lang.String advertise, java.lang.String advertiseUri, Configuration config)
newBuilder()
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@PluginBuilderFactory public static <B extends FileAppender.Builder<B>> B newBuilder()
public java.lang.String getFileName()
public boolean stop(long timeout, java.util.concurrent.TimeUnit timeUnit)
AbstractFilterable
stop
in interface LifeCycle2
stop
in class AbstractOutputStreamAppender<FileManager>
timeout
- the maximum time to waittimeUnit
- the time unit of the timeout argument