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 an OutputStream which must be specified through a ".outputStream" logging property.

Field Summary

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.

Constructor Summary

ArchivingFileHandler()
No-arg constructor to be used by the log manager.

ArchivingFileHandler(java.lang.String propertyNamePrefix)
Single-arg constructor to be used by proxies.

ArchivingFileHandler(java.lang.String pattern, long sizeLimit, TimeTable timeTable, boolean append, boolean autoFlush, java.util.logging.Level level, java.util.logging.Filter filter, java.util.logging.Formatter formatter, java.lang.String encoding)

Method Summary

void	publish(java.util.logging.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

Constructor Detail

ArchivingFileHandler

public ArchivingFileHandler()
                     throws ParseException,
                            EvaluationException,
                            java.io.IOException

No-arg constructor to be used by the log manager.

Throws:

ParseException

EvaluationException

java.io.IOException

ArchivingFileHandler

public ArchivingFileHandler(@Nullable
                            java.lang.String propertyNamePrefix)
                     throws ParseException,
                            EvaluationException,
                            java.io.IOException

Single-arg constructor to be used by proxies.

Throws:

ParseException

EvaluationException

java.io.IOException

ArchivingFileHandler

public ArchivingFileHandler(java.lang.String pattern,
                            long sizeLimit,
                            TimeTable timeTable,
                            boolean append,
                            boolean autoFlush,
                            java.util.logging.Level level,
                            java.util.logging.Filter filter,
                            java.util.logging.Formatter formatter,
                            java.lang.String encoding)
                     throws java.io.IOException

Parameters:

pattern - The pattern for the archive file names: '%d' is replaced with the current date

sizeLimit - The size limit for the current file

timeTable - The time table for time-based archiving

append - Whether to append to an existring current file

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:

java.io.IOException

Method Detail

publish

public void publish(java.util.logging.LogRecord record)

Overrides:

publish in class AbstractStreamHandler