@Plugin(name="RandomAccessFile", category="Core", elementType="appender", printObject=true) public final class RandomAccessFileAppender extends AbstractOutputStreamAppender<RandomAccessFileManager>
Modifier and Type | Class and Description |
---|---|
static class |
RandomAccessFileAppender.Builder<B extends RandomAccessFileAppender.Builder<B>>
Builds RandomAccessFileAppender instances.
|
LifeCycle.State
Modifier and Type | Field and Description |
---|---|
private java.lang.Object |
advertisement |
private Advertiser |
advertiser |
private java.lang.String |
fileName |
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
ELEMENT_TYPE
Modifier | Constructor and Description |
---|---|
private |
RandomAccessFileAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
RandomAccessFileManager manager,
java.lang.String filename,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser,
Property[] properties) |
Modifier and Type | Method and Description |
---|---|
void |
append(LogEvent event)
Write the log entry rolling over the file when required.
|
static <B extends RandomAccessFileAppender.Builder<B>> |
createAppender(java.lang.String fileName,
java.lang.String append,
java.lang.String name,
java.lang.String immediateFlush,
java.lang.String bufferSizeStr,
java.lang.String ignore,
Layout<? extends java.io.Serializable> layout,
Filter filter,
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 this appender is associated with.
|
static <B extends RandomAccessFileAppender.Builder<B>> |
newBuilder()
Creates a builder for a RandomAccessFileAppender.
|
boolean |
stop(long timeout,
java.util.concurrent.TimeUnit timeUnit)
Cleanup the Filter.
|
directEncodeEvent, getImmediateFlush, getManager, start, stop, writeByteArrayToManager
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toString
addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter
equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop
private final java.lang.String fileName
private java.lang.Object advertisement
private final Advertiser advertiser
private RandomAccessFileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, RandomAccessFileManager manager, java.lang.String filename, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
public boolean stop(long timeout, java.util.concurrent.TimeUnit timeUnit)
AbstractFilterable
stop
in interface LifeCycle2
stop
in class AbstractOutputStreamAppender<RandomAccessFileManager>
timeout
- the maximum time to waittimeUnit
- the time unit of the timeout argumentpublic void append(LogEvent event)
append
in interface Appender
append
in class AbstractOutputStreamAppender<RandomAccessFileManager>
event
- The LogEvent.public java.lang.String getFileName()
public int getBufferSize()
@Deprecated public static <B extends RandomAccessFileAppender.Builder<B>> RandomAccessFileAppender createAppender(java.lang.String fileName, java.lang.String append, java.lang.String name, java.lang.String immediateFlush, java.lang.String bufferSizeStr, java.lang.String ignore, Layout<? extends java.io.Serializable> layout, Filter filter, java.lang.String advertise, java.lang.String advertiseURI, Configuration configuration)
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".name
- The name of the Appender.immediateFlush
- "true" if the contents should be flushed on every
write, "false" otherwise. The default is "true".bufferSizeStr
- The buffer size, defaults to .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.configuration
- The Configuration.@PluginBuilderFactory public static <B extends RandomAccessFileAppender.Builder<B>> B newBuilder()