de.unkrig.commons.util.logging.handler

Class ArchivingFileHandler

java.lang.Object

java.util.logging.Handler

java.util.logging.StreamHandler

de.unkrig.commons.util.logging.handler.AbstractStreamHandler

de.unkrig.commons.util.logging.handler.ArchivingFileHandler

public class ArchivingFileHandler
extends AbstractStreamHandler

A log record handler which writes formatted records to files which are automatically archived.

Intially, if the "current log file" exists, it renames it (or, if it already exists and the "append" option is true, opens it in "append" mode).

Initially, the "current log file" is renamed and re-created and log records are written to it. When it is time to "archive" the current log file, then it is closed, renamed and re-created.

See Also:

The zero-parameter constructor that is used for properties-based configuration (as through the "{@code logging.properties}" file)

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_APPEND
static String	DEFAULT_PATTERN
static long	DEFAULT_SIZE_LIMIT
static TimeTable	DEFAULT_TIME_TABLE
static long	NO_LIMIT A special value for the sizeLimit paramter of ArchivingFileHandler(String, long, TimeTable, boolean, boolean, Level, Filter, Formatter, String) indicating that no limit should apply.

Fields inherited from class de.unkrig.commons.util.logging.handler.AbstractStreamHandler

DEFAULT_AUTO_FLUSH, DEFAULT_ENCODING, DEFAULT_FILTER, DEFAULT_FORMATTER, DEFAULT_LEVEL

Constructor Summary

Constructors

Modifier	Constructor and Description
	ArchivingFileHandler() The zero-parameter constructor (which is used by the LogManager).
protected	ArchivingFileHandler(int dummy, String propertyNamePrefix) Single-arg constructor to be used by proxies.
	ArchivingFileHandler(String pattern) Equivalent with ArchivingFileHandler(pattern, DEFAULT_SIZE_LIMIT, DEFAULT_TIME_TABLE, false, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).
	ArchivingFileHandler(String pattern, boolean append) Equivalent with ArchivingFileHandler(pattern, 9223372036854775807L, DEFAULT_TIME_TABLE, append, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).
	ArchivingFileHandler(String pattern, long sizeLimit) Equivalent with ArchivingFileHandler(pattern, sizeLimit, DEFAULT_TIME_TABLE, false, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).
	ArchivingFileHandler(String pattern, long sizeLimit, boolean append) Equivalent with ArchivingFileHandler(pattern, sizeLimit, DEFAULT_TIME_TABLE, append, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).
	ArchivingFileHandler(String pattern, long sizeLimit, TimeTable timeTable, boolean append, boolean autoFlush, Level level, Filter filter, Formatter formatter, String encoding) The pattern parameter determines the pathes of the log files, relative to the "user directory" (on most systems: the "current working directory"), with the following placeholder replacements: %% A literal "%" %h The "user home directory" (as determined by the "user.home" system property) %t The "default temp file path" (as determined by the "java.io.tmpdir" system property) %d The date and time of the archiving, in the DateFormat _yyyy-MM-dd_HH-mm-ss.
	ArchivingFileHandler(String pattern, TimeTable timeTable) Equivalent with ArchivingFileHandler(pattern, 9223372036854775807L, timeTable, false, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).
	ArchivingFileHandler(String pattern, TimeTable timeTable, boolean append) Equivalent with ArchivingFileHandler(pattern, 9223372036854775807L, timeTable, append, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).

Method Summary

Modifier and Type	Method and Description
void	publish(LogRecord record)

Methods inherited from class java.util.logging.StreamHandler

close, flush, isLoggable, setEncoding, setOutputStream

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_LIMIT

public static final long NO_LIMIT

A special value for the sizeLimit paramter of ArchivingFileHandler(String, long, TimeTable, boolean, boolean, Level, Filter, Formatter, String) indicating that no limit should apply.

See Also:

Constant Field Values

DEFAULT_PATTERN

public static final String DEFAULT_PATTERN

See Also:

Constant Field Values

DEFAULT_SIZE_LIMIT

public static final long DEFAULT_SIZE_LIMIT

See Also:

Constant Field Values

DEFAULT_TIME_TABLE

public static final TimeTable DEFAULT_TIME_TABLE

DEFAULT_APPEND

public static final boolean DEFAULT_APPEND

See Also:

Constant Field Values

Constructor Detail

ArchivingFileHandler

public ArchivingFileHandler()
                     throws ParseException,
                            EvaluationException,
                            IOException

The zero-parameter constructor (which is used by the LogManager). The ArchivingFileHandler, like all java.util.logging handlers, initializes itself with a set of "logging properties" which it retrieves through the LogManager, which normally reads them from the "logging.properties" file:

class-name.pattern

Determines the pathes of the log files; see the pattern parameter of ArchivingFileHandler(String, long, TimeTable, boolean, boolean, Level, Filter, Formatter, String). Defaults to "%h/java%d.log".

class-name.sizeLimit

Determines that log file archiving triggers when the size of the current log file exceeds a given threshold; an integral value, optionally followed by one of "k", "M", "G", "T", "P". Defaults to "none".

class-name.timeTable

An expression that defines the TimeTable for log file archiving with this syntax. Defaults to "never".
Example: "de.unkrig.commons.util.TimeTable.parse("*:0")" for "every full hour".

class-name.append

Whether to append to the current log file (if it initially exists); defaults to false.

Throws:

ParseException

EvaluationException

IOException

ArchivingFileHandler

protected ArchivingFileHandler(int dummy,
                               @Nullable
                               String propertyNamePrefix)
                        throws ParseException,
                               EvaluationException,
                               IOException

Single-arg constructor to be used by proxies. Constructor for extending classes that wish to impose different logging property than that used by ArchivingFileHandler().

Parameters:

dummy - Only there to distinguish this constructor from ArchivingFileHandler(String)

propertyNamePrefix - The property name prefix, or null to use the qualified name of the actual handler class

Throws:

ParseException

EvaluationException

IOException

ArchivingFileHandler

public ArchivingFileHandler(String pattern)
                     throws IOException

Equivalent with ArchivingFileHandler(pattern, DEFAULT_SIZE_LIMIT, DEFAULT_TIME_TABLE, false, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).

Throws:

IOException

ArchivingFileHandler

public ArchivingFileHandler(String pattern,
                            boolean append)
                     throws IOException

Equivalent with ArchivingFileHandler(pattern, 9223372036854775807L, DEFAULT_TIME_TABLE, append, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).

Throws:

IOException

ArchivingFileHandler

public ArchivingFileHandler(String pattern,
                            long sizeLimit)
                     throws IOException

Equivalent with ArchivingFileHandler(pattern, sizeLimit, DEFAULT_TIME_TABLE, false, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).

Throws:

IOException

ArchivingFileHandler

public ArchivingFileHandler(String pattern,
                            long sizeLimit,
                            boolean append)
                     throws IOException

Equivalent with ArchivingFileHandler(pattern, sizeLimit, DEFAULT_TIME_TABLE, append, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).

Throws:

IOException

ArchivingFileHandler

public ArchivingFileHandler(String pattern,
                            TimeTable timeTable)
                     throws IOException

Equivalent with ArchivingFileHandler(pattern, 9223372036854775807L, timeTable, false, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).

Throws:

IOException

ArchivingFileHandler

public ArchivingFileHandler(String pattern,
                            TimeTable timeTable,
                            boolean append)
                     throws IOException

Equivalent with ArchivingFileHandler(pattern, 9223372036854775807L, timeTable, append, true, AbstractStreamHandler.DEFAULT_LEVEL, AbstractStreamHandler.DEFAULT_FILTER, AbstractStreamHandler.DEFAULT_FORMATTER, AbstractStreamHandler.DEFAULT_ENCODING).

Throws:

IOException

ArchivingFileHandler

public ArchivingFileHandler(String pattern,
                            long sizeLimit,
                            TimeTable timeTable,
                            boolean append,
                            boolean autoFlush,
                            Level level,
                            @Nullable
                            Filter filter,
                            Formatter formatter,
                            @Nullable
                            String encoding)
                     throws IOException

The pattern parameter determines the pathes of the log files, relative to the "user directory" (on most systems: the "current working directory"), with the following placeholder replacements:

%%

A literal "%"

%h

The "user home directory" (as determined by the "user.home" system property)

%t

The "default temp file path" (as determined by the "java.io.tmpdir" system property)

%d

The date and time of the archiving, in the DateFormat _yyyy-MM-dd_HH-mm-ss. For the "current log file", "%d" is replaced with the empty string.
Iff the pattern does not contain a "%d" placeholder, then "%d" is silently appended to the pattern.

Parameters:

pattern - See the method description

sizeLimit - The size limit for the current file

timeTable - The time table for time-based archiving

append - Whether to append to the current log file (if it initially exists)

autoFlush - See StreamHandler.StreamHandler(OutputStream, boolean, Level, Filter, Formatter, String)

level - See StreamHandler.StreamHandler(OutputStream, boolean, Level, Filter, Formatter, String)

filter - See StreamHandler.StreamHandler(OutputStream, boolean, Level, Filter, Formatter, String)

formatter - See StreamHandler.StreamHandler(OutputStream, boolean, Level, Filter, Formatter, String)

encoding - See StreamHandler.StreamHandler(OutputStream, boolean, Level, Filter, Formatter, String)

Throws:

IOException

Method Detail

publish

public void publish(@Nullable
                    LogRecord record)

Overrides:

publish in class AbstractStreamHandler