org.eclipse.hyades.logging.events.cbe.util
Interface EventListener

public interface EventListener

Listener interface for receiving notification to process CommonBaseEvents and AssociationEngines when de-serializing a stream of Common Base Event and Association Engine XML fragments.

When de-serializing a stream of Common Base Event and Association Engine XML fragments, callers can process de-serialized CommonBaseEvents and AssociationEngines on a separate thread before the entire stream of Common Base Event and Association Engine XML fragments has been processed, resulting in a high level of parallelism and improved efficiency.

The EventFormatter provides methods for callers to register an implementation of this listener interface when de-serializing a stream of Common Base Event and Association Engine XML fragments.

Noteworthy, callers to the methods in the EventFormatter are responsible for listener instantiation, registration and clean-up.

See Also:

EventFormatter

Provisional API: This API is subject to change in the next release.

As of TPTP v4.2.0, this class is marked as 'provisional'.

Method Summary

void	processAssociationEngine(AssociationEngine associationEngine) Receives notification to process a AssociationEngine when de-serializing an Association Engine XML fragment.
void	processCommonBaseEvent(CommonBaseEvent commonBaseEvent) Receives notification to process a CommonBaseEvent when de-serializing a Common Base Event XML fragment.

Method Detail

processCommonBaseEvent

void processCommonBaseEvent(CommonBaseEvent commonBaseEvent)

Receives notification to process a CommonBaseEvent when de-serializing a Common Base Event XML fragment.

Once a Common Base Event XML fragment has been de-serialized by the EventFormatter, a CommonBaseEvent is constructed and broadcast to this method of the registered EventListener implementation for processing.

Parameters:

commonBaseEvent - The CommonBaseEvent to be processed.

Provisional API: This API is subject to change in the next release.

As of TPTP v4.2.0, this method is marked as 'provisional'.

processAssociationEngine

void processAssociationEngine(AssociationEngine associationEngine)

Receives notification to process a AssociationEngine when de-serializing an Association Engine XML fragment.

Once an Association Engine XML fragment has been de-serialized by the EventFormatter, an AssociationEngine is constructed and broadcast to this method of the registered EventListener implementation for processing.

Parameters:

associationEngine - The AssociationEngine to be processed.

Provisional API: This API is subject to change in the next release.

As of TPTP v4.2.0, this method is marked as 'provisional'.