org.xwiki.eventstream

Interface EventStore

@Role
 @Unstable
public interface EventStore

Save and access store events.

Since:

12.4RC1

Version:

$Id: 60f4f3af78937feea96f55ea500c8b2b063ae6d1 $

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Optional<Event>>	deleteEvent(Event event) Asynchronously deleted the event.
CompletableFuture<Optional<Event>>	deleteEvent(String eventId) Asynchronously deleted the event matching the passed identifier.
CompletableFuture<Optional<EventStatus>>	deleteEventStatus(EventStatus status) Asynchronously delete from the store the given status.
Optional<Event>	getEvent(String eventId) Get the event matching the passed identifier.
CompletableFuture<Event>	saveEvent(Event event) Asynchronously save in the store the given event.
CompletableFuture<EventStatus>	saveEventStatus(EventStatus status) Asynchronously save in the storage the given status.
EventSearchResult	search(EventQuery query) Search for event according to condition provided by the EventQuery.

Method Detail

saveEvent

CompletableFuture<Event> saveEvent(Event event)

Asynchronously save in the store the given event.

Parameters:

event - the event to save

Returns:

the new CompletableFuture providing the added Event

Since:

12.5RC1

saveEventStatus

CompletableFuture<EventStatus> saveEventStatus(EventStatus status)

Asynchronously save in the storage the given status.

Parameters:

status - the status to save

Returns:

the new CompletableFuture providing the added EventStatus

Since:

12.5RC1

deleteEvent

CompletableFuture<Optional<Event>> deleteEvent(String eventId)

Asynchronously deleted the event matching the passed identifier.

Parameters:

eventId - the unique identifier of the event

Returns:

the new CompletableFuture providing the deleted Event or empty if none could be found

Since:

12.5RC1

deleteEvent

CompletableFuture<Optional<Event>> deleteEvent(Event event)

Asynchronously deleted the event. Do nothing if the passed event does not exist.

Parameters:

event - the event to remove from the store

Returns:

the new CompletableFuture providing the deleted Event or empty if none could be found

Since:

12.5RC1

deleteEventStatus

CompletableFuture<Optional<EventStatus>> deleteEventStatus(EventStatus status)

Asynchronously delete from the store the given status.

Parameters:

status - the status to delete

Returns:

the new CompletableFuture providing the deleted EventStatus or empty if none could be found

Since:

12.5RC1

getEvent

Optional<Event> getEvent(String eventId)
                  throws EventStreamException

Get the event matching the passed identifier.

Parameters:

eventId - the unique identifier of the event

Returns:

the event corresponding to the passed id or null of none could be found

Throws:

EventStreamException - when failing to get the event

search

EventSearchResult search(EventQuery query)
                  throws EventStreamException

Search for event according to condition provided by the EventQuery.

Parameters:

query - the query containing the filtering conditions

Returns:

the result of the search

Throws:

EventStreamException - when failing to execute the search