Index (XWiki Platform - Event Stream

A C D E G H I M O R S T U V

A

AbstractEventStreamEvent - Class in org.xwiki.eventstream.events: Abstract class for every event that is related to the EventStream.
AbstractEventStreamEvent() - Constructor for class org.xwiki.eventstream.events.AbstractEventStreamEvent
AbstractRecordableEventDescriptor - Class in org.xwiki.eventstream: Abstract implementation of RecordableEventDescriptor.
AbstractRecordableEventDescriptor(String, String) - Constructor for class org.xwiki.eventstream.AbstractRecordableEventDescriptor: Construct an AbstractRecordableEventDescriptor.
addEvent(Event) - Method in interface org.xwiki.eventstream.EventStream: Add a new event to the storage.
addEvents(Event...) - Method in class org.xwiki.eventstream.EventGroup: Add more events to this group.

C

clearEvents() - Method in class org.xwiki.eventstream.EventGroup: Remove all the events from this group.
contextualLocalizationManager - Variable in class org.xwiki.eventstream.AbstractRecordableEventDescriptor
convert(RecordableEvent, String, Object) - Method in interface org.xwiki.eventstream.RecordableEventConverter: Convert a notification event to a stream event.
createEvent() - Method in interface org.xwiki.eventstream.EventFactory: Create a new event with some fields already filled in.
createRawEvent() - Method in interface org.xwiki.eventstream.EventFactory: Create a new event without any of the fields filled in.

D

deleteEvent(Event) - Method in interface org.xwiki.eventstream.EventStream: Delete an event from the storage.

E

equals(Object) - Method in class org.xwiki.eventstream.AbstractRecordableEventDescriptor
Event - Interface in org.xwiki.eventstream: A recorded event that occurred at some point in the wiki.
Event.Importance - Enum in org.xwiki.eventstream: The importance of an event.
EVENT_LOOP_CONTEXT_LOCK_PROPERTY - Static variable in class org.xwiki.eventstream.events.AbstractEventStreamEvent: Used to provide a key to a property in the current execution context that avoids stepping into a loop when triggering new events.
EventFactory - Interface in org.xwiki.eventstream: A factory which creates Event objects ready to be used.
EventGroup - Class in org.xwiki.eventstream: A group of related events, all happening as a consequence of the same action.
EventGroup() - Constructor for class org.xwiki.eventstream.EventGroup: Default constructor that creates an empty event group.
EventGroup(List<Event>) - Constructor for class org.xwiki.eventstream.EventGroup: Constructor that creates a group containing the passed events.
EventGroup(Set<Event>) - Constructor for class org.xwiki.eventstream.EventGroup: Constructor that creates a group containing the passed events.
EventGroup(Event...) - Constructor for class org.xwiki.eventstream.EventGroup: Constructor that creates a group containing the passed events.
EventStatus - Interface in org.xwiki.eventstream: Define a status for any couple of event/entity.
EventStatusManager - Interface in org.xwiki.eventstream: Handle the statuses for the events.
EventStream - Interface in org.xwiki.eventstream: The stream of events, allowing to store and retrieve events.
EventStreamAddedEvent - Class in org.xwiki.eventstream.events: Event triggered when a new event is registered inside of the EventStream.
EventStreamAddedEvent() - Constructor for class org.xwiki.eventstream.events.EventStreamAddedEvent
EventStreamDeletedEvent - Class in org.xwiki.eventstream.events: Event triggered when an event is deleted from the EventStream.
EventStreamDeletedEvent() - Constructor for class org.xwiki.eventstream.events.EventStreamDeletedEvent
EventStreamException - Exception in org.xwiki.eventstream: Exception specific to the Event Stream module.
EventStreamException() - Constructor for exception org.xwiki.eventstream.EventStreamException: Construct an EventStreamException.
EventStreamException(String) - Constructor for exception org.xwiki.eventstream.EventStreamException: Construct an EventStreamException.
EventStreamException(String, Throwable) - Constructor for exception org.xwiki.eventstream.EventStreamException: Construct an EventStreamException.
EventStreamException(Throwable) - Constructor for exception org.xwiki.eventstream.EventStreamException: Construct an EventStreamException.
EventStreamScriptService - Class in org.xwiki.eventstream.script: Script services for the Event Stream Module.
EventStreamScriptService() - Constructor for class org.xwiki.eventstream.script.EventStreamScriptService

G

getApplication() - Method in interface org.xwiki.eventstream.Event: Events can be triggered by different applications, not only the main wiki update events: user statuses, blog pingbacks, new extension added...
getApplicationIcon() - Method in interface org.xwiki.eventstream.RecordableEventDescriptor
getApplicationId() - Method in interface org.xwiki.eventstream.RecordableEventDescriptor
getApplicationName() - Method in class org.xwiki.eventstream.AbstractRecordableEventDescriptor
getApplicationName() - Method in interface org.xwiki.eventstream.RecordableEventDescriptor
getAuthorReference() - Method in interface org.xwiki.eventstream.UntypedRecordableEventDescriptor: Get a DocumentReference to the author of the descriptor.
getBody() - Method in interface org.xwiki.eventstream.Event: A larger section of text where the event can store some data.
getDate() - Method in interface org.xwiki.eventstream.Event: An event happens at a precise date.
getDescription() - Method in class org.xwiki.eventstream.AbstractRecordableEventDescriptor
getDescription() - Method in interface org.xwiki.eventstream.RecordableEventDescriptor
getDescriptorForEventType(String, boolean) - Method in interface org.xwiki.eventstream.RecordableEventDescriptorManager
getDescriptorForEventType(String, boolean) - Method in class org.xwiki.eventstream.script.EventStreamScriptService
getDocument() - Method in interface org.xwiki.eventstream.Event: Document-related events target a certain document.
getDocumentTitle() - Method in interface org.xwiki.eventstream.Event: The document title is usually more important than the document name.
getDocumentVersion() - Method in interface org.xwiki.eventstream.Event: For events related to documents, this field records the version of the document at the time when the event occurred.
getEntityId() - Method in interface org.xwiki.eventstream.EventStatus
getEvent() - Method in interface org.xwiki.eventstream.EventStatus
getEvents() - Method in class org.xwiki.eventstream.EventGroup: List the events that are part of this group.
getEventStatus(List<Event>, List<String>) - Method in interface org.xwiki.eventstream.EventStatusManager: Get the list of statuses concerning the given events and the given entities.
getEventTriggers() - Method in interface org.xwiki.eventstream.UntypedRecordableEventDescriptor: Get a list of the events that should trigger this particular event.
getEventType() - Method in interface org.xwiki.eventstream.RecordableEventDescriptor
getEventType() - Method in interface org.xwiki.eventstream.UntypedRecordableEvent: Get the event type (the hint) of the current event.
getEventTypeIcon() - Method in interface org.xwiki.eventstream.RecordableEventDescriptor
getFilter() - Method in interface org.xwiki.eventstream.RecordableEventDescriptor
getGroupId() - Method in interface org.xwiki.eventstream.Event: Multiple events can correspond to the same activity, so events can be grouped under the same GroupID.
getId() - Method in interface org.xwiki.eventstream.Event: Each event has a unique ID.
getImportance() - Method in interface org.xwiki.eventstream.Event: Different events can have a different importance.
getMainEvent() - Method in class org.xwiki.eventstream.EventGroup: Get the most important event in this group.
getObjectTypes() - Method in interface org.xwiki.eventstream.UntypedRecordableEventDescriptor: Get the object that, associated with one of the events returned by UntypedRecordableEventDescriptor.getEventTriggers() should trigger this particular event.
getParameters() - Method in interface org.xwiki.eventstream.Event
getRecordableEventDescriptors(boolean) - Method in interface org.xwiki.eventstream.RecordableEventDescriptorManager
getRecordableEventDescriptors(boolean) - Method in class org.xwiki.eventstream.script.EventStreamScriptService
getRelatedEntity() - Method in interface org.xwiki.eventstream.Event: Some events may be related to a more specific entity in the target document, like an attachment or an object, or may relate to another document besides the main related document.
getRelatedEvents(Event) - Method in interface org.xwiki.eventstream.EventStream: Retrieve the group that a given event is part of.
getSpace() - Method in interface org.xwiki.eventstream.Event: Document-related events target a certain document, and documents belong to a space; this is the space of the target document.
getStream() - Method in interface org.xwiki.eventstream.Event: Events can happen in different contexts; for example, wiki activity events happen in different spaces, user statuses are targeted to different groups.
getSupportedEvents() - Method in interface org.xwiki.eventstream.RecordableEventConverter
getTarget() - Method in interface org.xwiki.eventstream.Event
getTarget() - Method in interface org.xwiki.eventstream.TargetableEvent
getTitle() - Method in interface org.xwiki.eventstream.Event: A name for the event.
getType() - Method in interface org.xwiki.eventstream.Event: Events have different types: adding a comment, updating an attachment, importing an application, etc.
getUrl() - Method in interface org.xwiki.eventstream.Event: If an event happens in an URL-accessible location (a document), or if the event itself can be seen at a given URL, this field stores that URL.
getUser() - Method in interface org.xwiki.eventstream.Event: Event usually occur as the result of a registered user activity.
getValidationExpression() - Method in interface org.xwiki.eventstream.UntypedRecordableEventDescriptor: Gets the event validation expression.
getWiki() - Method in interface org.xwiki.eventstream.Event: In a wiki farm, each event happens in one of the wikis.

H

hashCode() - Method in class org.xwiki.eventstream.AbstractRecordableEventDescriptor

I

isRead() - Method in interface org.xwiki.eventstream.EventStatus

M

matches(Object) - Method in class org.xwiki.eventstream.events.AbstractEventStreamEvent

O

org.xwiki.eventstream - package org.xwiki.eventstream
org.xwiki.eventstream.events - package org.xwiki.eventstream.events
org.xwiki.eventstream.script - package org.xwiki.eventstream.script

R

RecordableEvent - Interface in org.xwiki.eventstream: An event that should be stored by the Event Stream.
RecordableEventConverter - Interface in org.xwiki.eventstream: Convert a RecordableEvent to an Event that could be stored in the event stream.
RecordableEventDescriptor - Interface in org.xwiki.eventstream: Provide a description for a specific implementation of RecordableEvent so that users can knows what the event is about.
RecordableEventDescriptor.EventFilter - Enum in org.xwiki.eventstream: The different filters we support to retrieve event.
RecordableEventDescriptorManager - Interface in org.xwiki.eventstream: Get all RecordableEventDescriptors that are present in the wiki.

S

saveEventStatus(EventStatus) - Method in interface org.xwiki.eventstream.EventStatusManager: Save in the storage the given status.
searchEvents(Query) - Method in interface org.xwiki.eventstream.EventStream: Search stored events.
setApplication(String) - Method in interface org.xwiki.eventstream.Event
setBody(String) - Method in interface org.xwiki.eventstream.Event
setDate(Date) - Method in interface org.xwiki.eventstream.Event
setDocument(DocumentReference) - Method in interface org.xwiki.eventstream.Event
setDocumentTitle(String) - Method in interface org.xwiki.eventstream.Event
setDocumentVersion(String) - Method in interface org.xwiki.eventstream.Event
setGroupId(String) - Method in interface org.xwiki.eventstream.Event
setId(String) - Method in interface org.xwiki.eventstream.Event
setImportance(Event.Importance) - Method in interface org.xwiki.eventstream.Event
setParameters(Map<String, String>) - Method in interface org.xwiki.eventstream.Event
setRelatedEntity(EntityReference) - Method in interface org.xwiki.eventstream.Event
setSpace(SpaceReference) - Method in interface org.xwiki.eventstream.Event
setStream(String) - Method in interface org.xwiki.eventstream.Event
setTarget(Set<String>) - Method in interface org.xwiki.eventstream.Event
setTitle(String) - Method in interface org.xwiki.eventstream.Event
setType(String) - Method in interface org.xwiki.eventstream.Event
setUrl(URL) - Method in interface org.xwiki.eventstream.Event
setUser(DocumentReference) - Method in interface org.xwiki.eventstream.Event
setWiki(WikiReference) - Method in interface org.xwiki.eventstream.Event

T

TargetableEvent - Interface in org.xwiki.eventstream: An event that specify which entities are concerned or interested by it.
toString() - Method in class org.xwiki.eventstream.EventGroup

U

UntypedRecordableEvent - Interface in org.xwiki.eventstream: This interface represents an event that is not identified by a specific class, but by its component hint.
UntypedRecordableEventDescriptor - Interface in org.xwiki.eventstream: This interface represents the descriptor of an UntypedRecordableEvent.

V

valueOf(String) - Static method in enum org.xwiki.eventstream.Event.Importance: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.eventstream.RecordableEventDescriptor.EventFilter: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.eventstream.Event.Importance: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.xwiki.eventstream.RecordableEventDescriptor.EventFilter: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I M O R S T U V