cz.cuni.amis.pogamut.base.utils.logging

Class LogPublisher

java.lang.Object

cz.cuni.amis.pogamut.base.utils.logging.LogPublisher

All Implemented Interfaces:

ILogPublisher

Direct Known Subclasses:

JMXLogPublisher, LogPublisher.ConsolePublisher, LogPublisher.FilePublisher, NetworkLogPublisher

public abstract class LogPublisher
extends Object
implements ILogPublisher

Implementation for the ILogPublisher interface that contains a Formatter for the LogRecords.

As default SimpleFormatter from the java.logging API is used.

Contains two default implementations ConsolePublisher and FilePublisher.

Author:

Jimmy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogPublisher.ConsolePublisher
static class	LogPublisher.FilePublisher

Field Summary

Fields

Modifier and Type	Field and Description
protected Formatter	formatter

Constructor Summary

Constructors

Constructor and Description
LogPublisher()
LogPublisher(Formatter formatter)
LogPublisher(IAgentId name)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() From JavaDoc API:
abstract void	flush() From JavaDoc API:
Formatter	getFormatter()
void	publish(LogRecord record) From JavaDoc API:
abstract void	publish(LogRecord record, String formattedMsg)
void	setFormatter(Formatter formatter)

Methods inherited from class java.lang.Object

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

Field Detail

formatter

protected Formatter formatter

Constructor Detail

LogPublisher

public LogPublisher()

LogPublisher

public LogPublisher(IAgentId name)

LogPublisher

public LogPublisher(Formatter formatter)

Method Detail

getFormatter

public Formatter getFormatter()

setFormatter

public void setFormatter(Formatter formatter)

close

public abstract void close()
                    throws SecurityException

Description copied from interface: ILogPublisher

From JavaDoc API:

Close the Handler and free all associated resources.

The close method will perform a flush and then close the Handler. After close has been called this Handler should no longer be used. Method calls may either be silently ignored or may throw runtime exceptions.

Specified by:

close in interface ILogPublisher

Throws:

SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

flush

public abstract void flush()

Description copied from interface: ILogPublisher

From JavaDoc API:

Flush any buffered output.

Specified by:

flush in interface ILogPublisher

publish

public abstract void publish(LogRecord record,
           String formattedMsg)

publish

public void publish(LogRecord record)

Description copied from interface: ILogPublisher

From JavaDoc API:

Publish a LogRecord.

The logging request was made initially to a Logger object, which initialized the LogRecord and forwarded it here.

The Handler is responsible for formatting the message, when and if necessary. The formatting should include localization.

Specified by:

publish in interface ILogPublisher

Parameters:

record - description of the log event. A null record is silently ignored and is not published