org.fujion.logging

Class LogUtil

java.lang.Object

org.fujion.logging.LogUtil

public class LogUtil
extends Object

Convenience methods for initializing logging settings on the client. These are used during application startup. Changing these settings after application startup will only affect new sessions.

Client logging settings are specified in an external property file. A logging target can be specified for each logging level. For example, the client can be configured to log fatal and error level messages at the server, debug at both the client and the server, and all others only at the client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogUtil.LogLevel Supported log levels.
static class	LogUtil.LogTarget Client logging targets.

Method Summary

Modifier and Type	Method and Description
static String	getSettingsForClient() Returns a JSON string that will be used by the client to initialize logging settings.
static LogUtil.LogTarget	getTarget(LogUtil.LogLevel level) Returns the client logging target for the specified logging level.
static void	initSettings(Map<String,String> settings) Initializes client logging settings.
static LogUtil.LogTarget	setTarget(LogUtil.LogLevel level, LogUtil.LogTarget target) Sets the client logging target for a given logging level.
static LogUtil.LogLevel	toLevel(String level) Returns the logging level from its text equivalent.
static LogUtil.LogTarget	toTarget(String target) Returns the logging target from its text equivalent.

Methods inherited from class java.lang.Object

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

Method Detail

initSettings

public static void initSettings(Map<String,String> settings)

Initializes client logging settings. This is called during application startup to inject logging settings specified in an external property file.

Parameters:

settings - Map of logging settings.

getTarget

public static LogUtil.LogTarget getTarget(LogUtil.LogLevel level)

Returns the client logging target for the specified logging level.

Parameters:

level - The logging level.

Returns:

The client logging target.

setTarget

public static LogUtil.LogTarget setTarget(LogUtil.LogLevel level,
                                          LogUtil.LogTarget target)

Sets the client logging target for a given logging level.

Parameters:

level - The logging level.

target - The logging target.

Returns:

The previous logging target, if any.

getSettingsForClient

public static String getSettingsForClient()

Returns a JSON string that will be used by the client to initialize logging settings.

Returns:

A JSON string that will be used by the client to initialize logging settings.

toLevel

public static LogUtil.LogLevel toLevel(String level)

Returns the logging level from its text equivalent.

Parameters:

level - Text to convert.

Returns:

The logging level.

toTarget

public static LogUtil.LogTarget toTarget(String target)

Returns the logging target from its text equivalent.

Parameters:

target - Text to convert.

Returns:

The logging target.