org.xwiki.eventstream.script

Class EventStreamScriptService

java.lang.Object

org.xwiki.eventstream.script.EventStreamScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Singleton
 @Named(value="eventstream")
 @Unstable
public class EventStreamScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Script services for the Event Stream Module.

Since:

9.2RC1

Version:

$Id: 275759fb8b33772bfd67f84322ea4ff1bbb49ed1 $

Constructor Summary

Constructors

Constructor and Description
EventStreamScriptService()

Method Summary

Modifier and Type	Method and Description
RecordableEventDescriptor	getDescriptorForEventType(String eventType, boolean allWikis)
List<RecordableEventDescriptor>	getRecordableEventDescriptors(boolean allWikis)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventStreamScriptService

public EventStreamScriptService()

Method Detail

getRecordableEventDescriptors

public List<RecordableEventDescriptor> getRecordableEventDescriptors(boolean allWikis)
                                                              throws EventStreamException

Parameters:

allWikis - load the descriptors from all the wikis of the farm if true

Returns:

the list of the available RecordableEventDescriptors

Throws:

EventStreamException - if an error happens

Since:

9.5.1, 9.6RC1

getDescriptorForEventType

public RecordableEventDescriptor getDescriptorForEventType(String eventType,
                                                           boolean allWikis)
                                                    throws EventStreamException

Parameters:

eventType - the type of the event

allWikis - load the descriptors from all the wikis of the farm if true

Returns:

the corresponding RecordableEventDescriptor or null if no one matches

Throws:

EventStreamException - if an error happens

Since:

9.10RC1