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")
public class EventStreamScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Script services for the Event Stream Module.

Since:

9.2RC1

Version:

$Id: 7e1d235d67bd425969f0a33c383f275359a55bb7 $

Constructor Summary

Constructors

Constructor and Description
EventStreamScriptService()

Method Summary

Modifier and Type	Method and Description
RecordableEventDescriptor	getDescriptorForEventType(String eventType, boolean allWikis)
long	getEventCount()
long	getLegacyEventCount()
org.xwiki.job.event.status.JobStatus	getLegacyMigrationStatus() Get the status of the job responsible for copying legacy event in the new store.
List<RecordableEventDescriptor>	getRecordableEventDescriptors(boolean allWikis)
org.xwiki.job.event.status.JobStatus	startLegacyMigration(Date since)

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

getLegacyMigrationStatus

@Unstable
public org.xwiki.job.event.status.JobStatus getLegacyMigrationStatus()

Get the status of the job responsible for copying legacy event in the new store.

Returns:

the status of the process

Since:

12.6

startLegacyMigration

@Unstable
public org.xwiki.job.event.status.JobStatus startLegacyMigration(Date since)
                                                                    throws org.xwiki.job.JobException

Parameters:

since - the date after which to copy the events, null for all time

Returns:

the status of the started process

Throws:

org.xwiki.job.JobException - when failing to start the job

Since:

12.6

getLegacyEventCount

public long getLegacyEventCount()
                         throws QueryException

Returns:

the total number of events in the legacy store

Throws:

QueryException - when failing to query the events

Since:

12.6.1, 12.7RC1

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