org.alfresco.bm.driver.event

Interface EventService

All Known Implementing Classes:

AbstractEventService, MongoEventService

public interface EventService

Interface for classes that handle persistence and retrieval of events.

Note that the next event is the event that should be processed next and not necessarily the event at the head of the queue.

Since:

1.0

Author:

Derek Hulley, Frank Becker

Method Summary

Modifier and Type	Method and Description
boolean	clear() Clears all recorded data
long	count()
boolean	deleteEvent(Event event) Delete an event from the provider.
Event	getEvent(String id) Retrieve an event by ID
List<Event>	getEvents(int skip, int limit) Only useful for testing: Retrieve all events with paging
Event	nextEvent(String driverId, long latestScheduledTime) Retrieve the next event in the queue.
String	putEvent(Event event) Adds an event to the provider.

Method Detail

count

long count()

Returns:

Returns the number of events in the queue

putEvent

String putEvent(Event event)

Adds an event to the provider. This is done to populate the queue with a new event to be processed.

Parameters:

event - the event to add (the event ID must be null

Returns:

the ID of the event

getEvent

Event getEvent(String id)

Retrieve an event by ID

Parameters:

id - the ID of the event as given in put

Returns:

the event by ID or null if it does not exist

getEvents

List<Event> getEvents(int skip,
                      int limit)

Only useful for testing: Retrieve all events with paging

nextEvent

Event nextEvent(String driverId,
                long latestScheduledTime)

Retrieve the next event in the queue. If the driver assignment is ignored, then the scheduled time should be adjusted so that events for other drivers are only picked up after a respectable time has passed i.e. the other drivers have been given a chance to process their events but did not.

This method must update the event queue time to the current time atomically.

Parameters:

driverId - the ID of the driver performing the search. When supplied, only events that are assigned to the driver are fetched; when null) any other driver's events can be fetched as well. Not that this is independent of data afinity, which is always respected here.

latestScheduledTime - the maximum scheduled time for events

respectDataAfinity - true if the fetch should only fetch events bound to the current test run instance.

Returns:

Returns the next event in the queue or null

deleteEvent

boolean deleteEvent(Event event)

Delete an event from the provider. This can be done after the event has been fully processed and there is no further requirement for it.

NOTE: The data cannot be accessed after this event.

Parameters:

event - the event to delete

Returns:

true if the event was deleted otherwise false

clear

boolean clear()

Clears all recorded data

Returns:

true if success, false else

Since:

2.1.4