flex.messaging.log
Interface Target

All Known Implementing Classes:

AbstractTarget, ConsoleTarget, LineFormattedTarget, ServletLogTarget

public interface Target

All logger target implementations within the logging framework must implement this interface. Target implementations receive log events and output information from these events to the appropriate output destination which may be a console, log file or some other custom destination.

Method Summary

void	addFilter(String value) Adds the category filteer that the Target will process log events for.
void	addLogger(Logger logger) Adds a Logger whose category matches the filters list for the Target.
List	getFilters() Returns the category filters defined for the Target.
short	getLevel() Returns the log level that the Target will process log events for.
void	initialize(String id, ConfigMap properties) Initializes the target with id and properties.
void	logEvent(LogEvent event) Logs a log event out to the Targets output destination, which may be the console or a log file.
void	removeFilter(String value) Removes a category filter from the list of filters the Target will process log events for.
void	removeLogger(Logger logger) Removes a Logger from the Target.
void	setFilters(List value) Sets the category filters that the Target will process log events for.
void	setLevel(short value) Sets the log level that the Target will process log events for.

Method Detail

initialize

void initialize(String id,
                ConfigMap properties)

Initializes the target with id and properties.

Parameters:

id - id for the target.

properties - ConfigMap of properties for the target.

getFilters

List getFilters()

Returns the category filters defined for the Target.

Returns:

The category filters defined for the Target.

setFilters

void setFilters(List value)

Sets the category filters that the Target will process log events for.

Parameters:

value - The category filters that the Target will process log events for.

addFilter

void addFilter(String value)

Adds the category filteer that the Target will process log events for.

Parameters:

value - The new category filter to add to the Target's list of filters.

removeFilter

void removeFilter(String value)

Removes a category filter from the list of filters the Target will process log events for.

Parameters:

value - The category filter to remove from the Target's list of filters.

getLevel

short getLevel()

Returns the log level that the Target will process log events for. Log events at this level, or at a higher priority level will be processed.

Returns:

The log level that the Target will process log events for.

setLevel

void setLevel(short value)

Sets the log level that the Target will process log events for. Log events at this level, or at a higher priority level will be processed.

Parameters:

value - The log level that the Target will process log events for.

addLogger

void addLogger(Logger logger)

Adds a Logger whose category matches the filters list for the Target. The Logger will dispatch log events to this Target to be output.

Parameters:

logger - The Logger to add.

removeLogger

void removeLogger(Logger logger)

Removes a Logger from the Target.

Parameters:

logger - The Logger to remove.

logEvent

void logEvent(LogEvent event)

Logs a log event out to the Targets output destination, which may be the console or a log file.

Parameters:

event - The LogEvent containing the information to output.