flex.messaging.log
Class Log

java.lang.Object
  flex.messaging.log.Log

public class Log
extends Object

Method Summary

static void	addTarget(Target target) Adds a target to the log.
static boolean	checkFilterToCategory(String filter, String category)
static void	clear() Clean up static member variables.
static Log	createLog() Creates the log on first access, returns already created log on subsequent calls.
static Logger	getLogger(String category) Given a category, returns the logger associated with the category.
String[]	getLoggers()
static Target	getTarget(String searchId) Returns the target associated with the unique ID searchId.
static Map	getTargetMap()
static List	getTargets() Returns an unmodifiable snapshot of the targets registered with this Log when the method is invoked.
static void	initialize(String id, ConfigMap properties) Initializes Log with id and properties.
static boolean	isDebug() Indicates whether a debug level log event will be processed by a log target.
static boolean	isError() Indicates whether an error level log event will be processed by a log target.
static boolean	isExcludedProperty(String property) Indicates whether a log property should be excluded.
static boolean	isFatal() Indicates whether a fatal level log event will be processed by a log target.
static boolean	isInfo() Indicates whether an info level log event will be processed by a log target.
static boolean	isWarn() Indicates whether a warn level log event will be processed by a log target.
static void	removeTarget(Target target) Removes a target from the log.
static void	reset() This method removes all of the current loggers and targets from the cache.

Methods inherited from class java.lang.Object

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

Method Detail

createLog

public static Log createLog()

Creates the log on first access, returns already created log on subsequent calls.

Returns:

log.

initialize

public static void initialize(String id,
                              ConfigMap properties)

Initializes Log with id and properties.

Parameters:

id - Id for the Log which is ignored, though is used by the ManageableComponent superclass

properties - ConfigMap of properties for the Log.

isFatal

public static boolean isFatal()

Indicates whether a fatal level log event will be processed by a log target.

isError

public static boolean isError()

Indicates whether an error level log event will be processed by a log target.

isWarn

public static boolean isWarn()

Indicates whether a warn level log event will be processed by a log target.

isInfo

public static boolean isInfo()

Indicates whether an info level log event will be processed by a log target.

isDebug

public static boolean isDebug()

Indicates whether a debug level log event will be processed by a log target.

isExcludedProperty

public static boolean isExcludedProperty(String property)

Indicates whether a log property should be excluded.

getLogger

public static Logger getLogger(String category)

Given a category, returns the logger associated with the category.

Parameters:

category - Categogry for the logger.

Returns:

Logger associated with the category.

getTargets

public static List getTargets()

Returns an unmodifiable snapshot of the targets registered with this Log when the method is invoked.

getTargetMap

public static Map getTargetMap()

Returns:

the Log's map of targets keyed on their human-readable ids (e.g. ConsoleTarget0, ConsoleTarget1, etc.)

getTarget

public static Target getTarget(String searchId)

Returns the target associated with the unique ID searchId. Returns null if no such target exists.

getLoggers

public String[] getLoggers()

Returns:

the categories for all of the loggers

addTarget

public static void addTarget(Target target)

Adds a target to the log.

Parameters:

target - Target to be added.

removeTarget

public static void removeTarget(Target target)

Removes a target from the log.

Parameters:

target - The target to be removed.

reset

public static void reset()

This method removes all of the current loggers and targets from the cache. and resets target level.

checkFilterToCategory

public static boolean checkFilterToCategory(String filter,
                                            String category)

Parameters:

filter - The filter string to check against a specific category

category - The category which the filter could match

Returns:

whether the filter matches a specific category

clear

public static void clear()

Clean up static member variables.