Module cl.netswitch.lib

Package cl.netswitch.lib.util

Class Logging

java.lang.Object

cl.netswitch.lib.util.Logging

public final class Logging
extends Object

Provides static utility methods used to configure the System Logging Facility.

Method Summary

Modifier and Type	Method	Description
static void	changeDefaultFormatters()	Changes the formatters of ConsoleHandler and FileHandler handlers by a LogFormatter.
static void	changeDefaultFormatters(Formatter formatter)	Changes the formatters of ConsoleHandler and FileHandler handlers by supplied formatter.
static void	changeDefaultFormatters(Formatter formatter, boolean alwaysChange)	Changes the formatters of ConsoleHandler and FileHandler handlers by the supplied formatter.
static boolean	initialize(File configFile)	Initialize the logging facility using supplied configuration file.

Methods inherited from class java.lang.Object

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

Method Details

initialize

public static boolean initialize(File configFile)
                          throws SecurityException,
IOException

Initialize the logging facility using supplied configuration file. If the system properties "java.util.logging.config.class" and "java.util.logging.config.file" are not defined, the logging facility is reinitialized reading the configuration file, if it exists.

Parameters:

configFile - the configuration property file.

Returns:

true if the configuration file was loaded.

Throws:

NullPointerException - if configFile is null.

SecurityException - if a security error occurs.

IOException - if an I/O error occurs.

changeDefaultFormatters

public static void changeDefaultFormatters()
                                    throws SecurityException

Changes the formatters of ConsoleHandler and FileHandler handlers by a LogFormatter.

A ConsoleHandler is changed only if it's current formatter is a SimpleFormatter.

A FileHandler is changed only if it's current formatter is an XMLFormatter.

Throws:

SecurityException - if the formatter could not be changed.

changeDefaultFormatters

public static void changeDefaultFormatters(Formatter formatter)
                                    throws SecurityException

Changes the formatters of ConsoleHandler and FileHandler handlers by supplied formatter.

A ConsoleHandler is changed only if it's current formatter is a SimpleFormatter.

A FileHandler is changed only if it's current formatter is an XMLFormatter.

Parameters:

formatter - the logging formatter to be assign to standard handlers.

Throws:

NullPointerException - if formatter is null.

SecurityException - if the formatter could not be changed.

changeDefaultFormatters

public static void changeDefaultFormatters(Formatter formatter,
 boolean alwaysChange)
                                    throws SecurityException

Changes the formatters of ConsoleHandler and FileHandler handlers by the supplied formatter.

A ConsoleHandler is changed if it's current formatter is a SimpleFormatter or if alwaysChange is true.

A FileHandler is changed if it's current formatter is an XMLFormatter or if alwaysChange is true.

Parameters:

formatter - the logging formatter to be assign to standard handlers.

alwaysChange - if true standard handlers are always changed.

Throws:

NullPointerException - if formatter is null.

SecurityException - if the formatter could not be changed.