org.xwiki.eventstream

Interface RecordableEventConverter

@Role
 @Unstable
public interface RecordableEventConverter

Convert a RecordableEvent to an Event that could be stored in the event stream.

Since:

9.2RC1

Version:

$Id: 9e52f35b3d1789d8a740e9bfcfba1f788d8f6158 $

Method Summary

Modifier and Type	Method and Description
Event	convert(RecordableEvent recordableEvent, String source, Object data) Convert a notification event to a stream event.
List<RecordableEvent>	getSupportedEvents()

Method Detail

convert

Event convert(RecordableEvent recordableEvent,
              String source,
              Object data)
       throws Exception

Convert a notification event to a stream event.

Parameters:

recordableEvent - the event to convert

source - the source received with the event

data - the data received with the event

Returns:

the converted stream event, ready to be stored

Throws:

Exception - if error happens

getSupportedEvents

List<RecordableEvent> getSupportedEvents()

Returns:

the list of events supported by this converter