Class RollingFileAppender

    • Method Detail

      • stop

        public boolean stop​(long timeout,
                            java.util.concurrent.TimeUnit timeUnit)
        Description copied from class: AbstractFilterable
        Cleanup the Filter.
        Specified by:
        stop in interface LifeCycle2
        Overrides:
        stop in class AbstractOutputStreamAppender<RollingFileManager>
        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.
      • getFileName

        public java.lang.String getFileName()
        Returns the File name for the Appender.
        Returns:
        The file name.
      • getFilePattern

        public java.lang.String getFilePattern()
        Returns the file pattern used when rolling over.
        Returns:
        The file pattern.
      • getTriggeringPolicy

        public <T extends TriggeringPolicy> T getTriggeringPolicy()
        Returns the triggering policy.
        Type Parameters:
        T - TriggeringPolicy type
        Returns:
        The TriggeringPolicy
      • createAppender

        @Deprecated
        public static <B extends RollingFileAppender.Builder<B>> RollingFileAppender createAppender​(java.lang.String fileName,
                                                                                                    java.lang.String filePattern,
                                                                                                    java.lang.String append,
                                                                                                    java.lang.String name,
                                                                                                    java.lang.String bufferedIO,
                                                                                                    java.lang.String bufferSizeStr,
                                                                                                    java.lang.String immediateFlush,
                                                                                                    TriggeringPolicy policy,
                                                                                                    RolloverStrategy strategy,
                                                                                                    Layout<? extends java.io.Serializable> layout,
                                                                                                    Filter filter,
                                                                                                    java.lang.String ignore,
                                                                                                    java.lang.String advertise,
                                                                                                    java.lang.String advertiseUri,
                                                                                                    Configuration config)
        Deprecated.
        Creates a RollingFileAppender.
        Parameters:
        fileName - The name of the file that is actively written to. (required).
        filePattern - The pattern of the file name to use on rollover. (required).
        append - If true, events are appended to the file. If false, the file is overwritten when opened. Defaults to "true"
        name - The name of the Appender (required).
        bufferedIO - When true, I/O will be buffered. Defaults to "true".
        bufferSizeStr - buffer size for buffered IO (default is 8192).
        immediateFlush - When true, events are immediately flushed. Defaults to "true".
        policy - The triggering policy. (required).
        strategy - The rollover strategy. Defaults to DefaultRolloverStrategy.
        layout - The layout to use (defaults to the default PatternLayout).
        filter - The Filter or null.
        ignore - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.
        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:
        A RollingFileAppender.