Package org.xwiki.eventstream.script

Class EventStreamScriptService

  • All Implemented Interfaces:
    org.xwiki.script.service.ScriptService
    @Component
@Singleton
@Named("eventstream")
public class EventStreamScriptService
extends Object
implements org.xwiki.script.service.ScriptService
    Script services for the Event Stream Module.
    Since:
    9.2RC1
    Version:
    $Id: f1189f72ebef322de910d3492b5a82d53edb1b0b $

    • 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

      • getEventCount

        public long getEventCount()
                   throws EventStreamException
        Returns:
        the total number of event in the store
        Throws:
        EventStreamException - when failing to query the number of events
        Since:
        12.6.1, 12.7RC1