Class FileAppender

    • 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.
        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.
      • 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 interface LifeCycle2
        Overrides:
        stop in class AbstractOutputStreamAppender<FileManager>
        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.