java.lang.Object
   |
   +--java.util.logging.Handler
         |
         +--java.util.logging.StreamHandler
               |
               +--java.util.logging.FileHandler

Deklaration

Beschreibung

Zur Konfiguration stehen vier Einstellungen zur Verfügung, die über den LogManager verwaltet werden. Diese Einstellungen können in der globalen Konfigurations-Datei abgelegt werden und werden bei der Initialisierung des Logging-Frameworks eingelesen. Im Einzelnen gehören dazu folgende Einstellungen:

• java.util.logging.FileHandler.level Log-Ebene des Handlers (voreingestellt ist Level.ALL).
• java.util.logging.FileHandler.filter Name einer Filter-Klasse, die als Filter benutzt wird (voreingestellt ist kein Filter).
• java.util.logging.ConsoleHandler.formatter Name einer Formatierer-Klasse, die zur Formatierung benutzt wird (voreingestellt ist java.util.logging.XMLFormatter).
• java.util.logging.ConsoleHandler.encoding Name des verwendeten Zeichensatzes (voreingestellt ist der Zeichensatz der verwendeten Plattform).
• java.util.logging.ConsoleHandler.limit Anzahl an Bytes, die ungefähr pro Datei geschrieben wird. Der Wert 0 bedeutet, dass kein Limit vorhanden ist (voreingestellt ist kein Limit).
• java.util.logging.ConsoleHandler.count Anzahl an Dateien, die für die Ausgabe benutzt werden.
• java.util.logging.ConsoleHandler.pattern Das Muster, nach dem die Namen der Ausgabe-Dateien aufgebaut sind (voreingestellt ist %h/java%u.log).
• java.util.logging.ConsoleHandler.append Gibt an, ob Anhängen von Protokoll-Einträgen an bereits existente Dateien möglich ist (voreingestellt ist false).

In einem Muster, das für die Angabe von Datei-Namen benutzt wird, können können spezielle Ausdrücke benutzt werden, die zur Laufzeit ersetzt werden. Besondere Bedeutung haben hierbei / (Trennzeichen für Pfade), %t (lokales temporäres Verzeichnis), %h (Wert der Property user.home), %g (generierte fortlaufende Nummer), %u (eindeutige Nummer, um Namenkonflikte zu vermeiden) und %% (Prozentzeichen).

Wenn das angegebene Muster nicht den Ausdruck %g enthält und in mehrere Dateien geschrieben wird, so wird der fortlaufende Zähler per Voreinstellung an das Ende des Datei-Namens durch einen Punkt getrennt angehängt (z. B. applog.1).

Eindeutige Nummern können vor allen Dingen dann wichtig sein, wenn die Protokoll-Dateien in das temporäre Verzeichnis des lokalen Rechner geschrieben wird, da dort verschiedene Anwendungen Dateien ablegen können.

Konstruktoren im Detail

public FileHandler()

Erzeugt einen neuen FileHandler, der über die Einstellungen des LogManager konfiguriert wird.

Exception: IOException

• Wenn ein Fehler beim Öffnen der Dateien auftritt. .

Exception: SecurityException

• Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission("control" besitzt.

public FileHandler(String pattern)

Erzeugt einen neuen FileHandler, dessen Protokoll-Dateien Namen nach dem übergebenen Muster haben. Alle anderen Einstellungen werden vom LogManager übernommen.

Exception: IOException

• Wenn ein Fehler beim Öffnen der Dateien auftritt. .

Exception: SecurityException

• Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission("control" besitzt.

public FileHandler(String pattern, boolean append)

Erzeugt einen neuen FileHandler, dessen Protokoll-Dateien Namen nach dem übergebenen Muster haben und dessen Protokoll-Einträge an bereits existente Protokoll-Dateien angehängt werden können (durch Angabe von true für den Parameter append). Alle anderen Einstellungen werden vom LogManager übernommen.

Exception: IOException

• Wenn ein Fehler beim Öffnen der Dateien auftritt. .

Exception: SecurityException

• Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission("control" besitzt.

public FileHandler(String pattern, int limit, int count)

Erzeugt einen neuen FileHandler, der in eine Menge an Ausgabe-Dateien schreibt. Wenn eine Datei die durch limit angegebene Dateigröße in Bytes erreicht, wird die aktuelle Datei geschlossen und eine neue Datei geöffnet. Dabei wird die Ausgabe zirkulär in eine Menge an Dateien geschrieben, deren Anzahl durch count angegeben wird (mindestens 1). pattern enthält das Muster, nach dem die Namen der Ausgabe-Dateien aufgebaut sind. Alle anderen Einstellungen werden vom LogManager übernommen.

Exception: IOException

• Wenn ein Fehler beim Öffnen der Dateien auftritt. .

Exception: SecurityException

• Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission("control" besitzt.

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

Erzeugt einen neuen FileHandler, der in eine Menge an Ausgabe-Dateien schreibt. Wenn eine Datei die durch limit angegebene Dateigröße in Bytes erreicht, wird die aktuelle Datei geschlossen und eine neue Datei geöffnet. Dabei wird die Ausgabe zirkulär in eine Menge an Dateien geschrieben, deren Anzahl durch count angegeben wird (mindestens 1). pattern enthält das Muster, nach dem die Namen der Ausgabe-Dateien aufgebaut sind. Durch append kann angegeben werden, ob die Ausgabe an bereits existente Protokoll-Dateien angehängt werden soll. Alle anderen Einstellungen werden vom LogManager übernommen.

Exception: IOException

• Wenn ein Fehler beim Öffnen der Dateien auftritt. .

Exception: SecurityException

• Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission("control" besitzt.

Methoden im Detail

public synchronized void close()

Schließt alle offenen Dateien.

Exception: SecurityException

• Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission("control" besitzt.

public synchronized void publish(LogRecord record)

Verarbeitet einen Protokoll-Eintrag. Dabei wird zunächst geprüft, ob eine Filter-Regel existiert, die den neuen Protokoll-Eintrag herausfiltert. Falls nicht, wird der neue Eintrag formatiert und anschließend in das aktuelle Protokoll geschrieben.