Класс FileHandler

public class FileHandler
extends StreamHandler

Простая запись логов в файлы Handler.

Класс может записывать данные в указанный файл или в набор вращающихся файлов.

При использовании вращающихся файлов, по достижении установленного лимита размера файла, он закрывается, и открывается новый файл. Последовательно более старые файлы будут именоваться добавлением "0", "1", "2" и т.д. к имени базового файла.

По умолчанию буферизация включена в библиотеках ввода-вывода, но каждый записываемый лог-запись сбрасывается в поток, когда запись завершена.

По умолчанию для форматирования используется класс XMLFormatter .

Конфигурация: Каждый FileHandler инициализируется по умолчанию используя следующие свойства конфигурации LogManager, где <handler-name> обозначает полное имя класса обработчика. Если свойства не заданы (или имеют некорректные значения), используются заданные значения по умолчанию.

• <handler-name>.level указывает уровень по умолчанию для Handler (по умолчанию Level.ALL).
• <handler-name>.filter указывает имя класса Filter для использования (по умолчанию без Filter).
• <handler-name>.formatter указывает имя класса Formatter для использования (по умолчанию java.util.logging.XMLFormatter)
• <handler-name>.encoding имя кодировки символов для использования (по умолчанию кодировка по умолчанию платформы).
• <handler-name>.limit указывает приблизительный максимальный размер записи (в байтах) в любом одном файле. Если значение равно нулю, лимита нет. (По умолчанию лимита нет).
• <handler-name>.count указывает количество файлов вывода, которые будут циклически использоваться (по умолчанию 1).
• <handler-name>.pattern указывает шаблон для генерации имени выходного файла. Подробности см. ниже. (По умолчанию "%h/java%u.log").
• <handler-name>.append указывает, должен ли FileHandler добавлять записи в существующие файлы (по умолчанию false).

Например, свойства для FileHandler будут следующими:

• java.util.logging.FileHandler.level=INFO
• java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Для пользовательского обработчика, например com.foo.MyHandler, свойства будут:

• com.foo.MyHandler.level=INFO
• com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter

Шаблон состоит из строки, которая включает следующие специальные компоненты, которые будут заменены во время выполнения:

• "/" разделитель пути
• "%t" временная директория системы
• "%h" значение системной переменной "user.home"
• "%g" номер генерации для различения вращающихся логов
• "%u" уникальное число для разрешения конфликтов
• "%%" преобразуется в одиночный знак процента "%"

Если поле "%g" не указано, а количество файлов больше единицы, то номер генерации будет добавлен в конец сгенерированного имени файла после точки.

Таким образом, например, шаблон "%t/java%g.log" с количеством 2 обычно приведет к записи лог-файлов в /var/tmp/java0.log и /var/tmp/java1.log на Solaris и в C:\TEMP\java0.log и C:\TEMP\java1.log на Windows 95.

Номера генераций следуют последовательности 0, 1, 2 и т.д.

Обычно поле "%u" уникального номера устанавливается в 0. Однако, если FileHandler пытается открыть файл и обнаруживает, что файл используется другим процессом, оно увеличивает поле уникального номера и пытается снова. Это будет повторяться, пока FileHandler не найдет имя файла, которое не используется. Если возникает конфликт и поле "%u" не указано, оно будет добавлено в конец имени файла после точки. (Это будет после любого автоматически добавленного номера генерации).

Таким образом, если три процесса пытаются записывать в fred%u.%g.txt, они могут получить fred0.0.txt, fred1.0.txt, fred2.0.txt в качестве первых файлов своих вращающихся последовательностей.

Обратите внимание, что использование уникальных идентификаторов для предотвращения конфликтов гарантированно работает только надежно при использовании локальной файловой системы.

Конструкторы

FileHandler

public FileHandler()
            throws IOException,
                   SecurityException

Исключение:

IOException - если возникли проблемы с вводом/выводом при открытии файлов.

SecurityException - если менеджер безопасности существует и вызывающий объект не имеет LoggingPermission("control")).

NullPointerException - если свойство pattern является пустой строкой.

FileHandler

public FileHandler(String pattern)
            throws IOException,
                   SecurityException

Параметры:

pattern - имя выходного файла

Исключение:

IOException - если возникли проблемы с вводом/выводом при открытии файлов.

SecurityException - если менеджер безопасности существует и вызывающий объект не имеет LoggingPermission("control").

IllegalArgumentException - если pattern является пустой строкой

FileHandler

public FileHandler(String pattern,
                   boolean append)
            throws IOException,
                   SecurityException

Параметры:

pattern - имя выходного файла

append - указывает режим добавления

Исключение:

IOException - если возникли проблемы с вводом/выводом при открытии файлов.

SecurityException - если менеджер безопасности существует и вызывающий объект не имеет LoggingPermission("control").

IllegalArgumentException - если pattern является пустой строкой

FileHandler

public FileHandler(String pattern,
                   int limit,
                   int count)
            throws IOException,
                   SecurityException

Параметры:

pattern - шаблон для именования выходного файла

limit - максимальное количество байтов для записи в любой один файл

count - количество используемых файлов

Исключение:

IOException - если возникли проблемы с вводом/выводом при открытии файлов.

SecurityException - если менеджер безопасности существует и вызывающий объект не имеет LoggingPermission("control").

IllegalArgumentException - если limit < 0, или count < 1.

IllegalArgumentException - если pattern является пустой строкой

FileHandler

public FileHandler(String pattern,
                   int limit,
                   int count,
                   boolean append)
            throws IOException,
                   SecurityException

Параметры:

pattern - шаблон для именования выходного файла

limit - максимальное количество байтов для записи в любой один файл

count - количество используемых файлов

append - указывает режим добавления

Исключение:

IOException - если возникли проблемы с вводом/выводом при открытии файлов.

SecurityException - если менеджер безопасности существует и вызывающий объект не имеет LoggingPermission("control").

IllegalArgumentException - если limit < 0, или count < 1.

IllegalArgumentException - если pattern является пустой строкой

Методы

publish

public void publish(LogRecord record)

Форматировать и опубликовать LogRecord.

Переопределяет:

publish в классе StreamHandler

Параметры:

record - описание события логирования. Null-объект игнорируется и не публикуется

close

public void close()
           throws SecurityException

Закрыть все файлы.

Переопределяет:

close в классе StreamHandler

Исключение:

SecurityException - если менеджер безопасности существует и вызывающий объект не имеет LoggingPermission("control").