org.alfresco.bm.common.mongo

Class MongoEventService

java.lang.Object

org.alfresco.bm.driver.event.AbstractEventService

org.alfresco.bm.common.mongo.MongoEventService

All Implemented Interfaces:

LifecycleListener, EventService

public class MongoEventService
extends AbstractEventService
implements LifecycleListener

An EventService MongoDB collection

Since:

1.0

Author:

Derek Hulley

Constructor Summary

Constructors

Constructor and Description
MongoEventService(com.mongodb.DB db, String collection) Construct a event service against a Mongo database and given collection name

Method Summary

Modifier and Type	Method and Description
boolean	clear() Clears all recorded data
static com.mongodb.DBObject	convertEvent(Event event) Helper method to convert an Event into a persistable object
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.
void	start()
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MongoEventService

public MongoEventService(com.mongodb.DB db,
                         String collection)

Construct a event service against a Mongo database and given collection name

Method Detail

start

public void start()

Specified by:

start in interface LifecycleListener

stop

public void stop()

Specified by:

stop in interface LifecycleListener

count

public long count()

Specified by:

count in interface EventService

Returns:

Returns the number of events in the queue

convertEvent

public static com.mongodb.DBObject convertEvent(Event event)

Helper method to convert an Event into a persistable object

putEvent

public String putEvent(Event event)

Description copied from interface: EventService

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

Specified by:

putEvent in interface EventService

Parameters:

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

Returns:

the ID of the event

getEvent

public Event getEvent(String id)

Description copied from interface: EventService

Retrieve an event by ID

Specified by:

getEvent in interface EventService

Parameters:

id - the ID of the event as given in put

Returns:

the event by ID or null if it does not exist

getEvents

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

Description copied from interface: EventService

Only useful for testing: Retrieve all events with paging

Specified by:

getEvents in interface EventService

nextEvent

public 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.

Specified by:

nextEvent in interface EventService

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

Returns:

Returns the next event in the queue or null

deleteEvent

public boolean deleteEvent(Event event)

Description copied from interface: EventService

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.

Specified by:

deleteEvent in interface EventService

Parameters:

event - the event to delete

Returns:

true if the event was deleted otherwise false

clear

public boolean clear()

Description copied from interface: EventService

Clears all recorded data

Specified by:

clear in interface EventService

Returns:

true if success, false else