genius.core.logging

Class XmlLogger

java.lang.Object

genius.core.logging.XmlLogger

All Implemented Interfaces:

Listener<NegotiationEvent>, java.io.Closeable, java.lang.AutoCloseable

public class XmlLogger
extends java.lang.Object
implements Listener<NegotiationEvent>, java.io.Closeable

Creates a logger which will log NegotiationEvents to a XML file. Logs the SessionEndedNormallyEvent.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.Map<java.lang.Object,java.lang.Object>>	agentLogs map where keys are the agent names.

Constructor Summary

Constructors

Constructor and Description
XmlLogger(java.io.OutputStream out, java.lang.String topLabel)

Method Summary

Modifier and Type	Method and Description
void	close()
void	notifyChange(NegotiationEvent e) a notification call that occurs when something changed.

Methods inherited from class java.lang.Object

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

Field Detail

agentLogs

protected java.util.Map<java.lang.String,java.util.Map<java.lang.Object,java.lang.Object>> agentLogs

map where keys are the agent names. The values are the logs returned by the agent through an AgentLogEvent.

Constructor Detail

XmlLogger

public XmlLogger(java.io.OutputStream out,
                 java.lang.String topLabel)
          throws java.io.FileNotFoundException,
                 javax.xml.stream.XMLStreamException

Parameters:

out - OutputStream to write the log to. If this is a file, we recommend to use the extension ".xml". This logger becomes owner of this outputstream and will close it eventually.

topLabel - the top level label to use in the output file

Throws:

java.io.FileNotFoundException

javax.xml.stream.XMLStreamException

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

notifyChange

public void notifyChange(NegotiationEvent e)

Description copied from interface: Listener

a notification call that occurs when something changed. Consult the parent object for details about this event.

NOTICE 1

notifications run in the thread of the caller. The caller will be blocked until this callback has been completed. It is therfore good practice to handle callbacks quickly.

NOTICE 2

Notifications often cross a thread sarety boundary. For example when in MVC a model (typically thread safe) calls back a panel (not thread safe). The called side (the panel) thus must handle the callback in a thread safe manner, e.g. using SwingUtilities.invokeLater(Runnable). We recommend to avoid synchronize as this will can block indefinitely (see notice 1) which might lead to deadlocks.

Specified by:

notifyChange in interface Listener<NegotiationEvent>

Parameters:

e - additional data, typically the new value associated with the event