Package com.attivio.sdk.client
Interface EventStoreApi
-
- All Known Implementing Classes:
MockUnclusteredEventStore
public interface EventStoreApi
Store, retrieve and acknowledge events.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
acknowledgeEvent(long eventId, java.lang.String user, java.lang.String reason)
long
addEvent(SystemEvent event)
long
countEvents()
SystemEvent
getEvent(long eventId)
EventQuery
getEvents(EventQuery eventQuery)
Executes the event query.
-
-
-
Method Detail
-
addEvent
long addEvent(SystemEvent event) throws AttivioException
- Parameters:
event
-- Returns:
- event Id
- Throws:
AttivioException
-
getEvents
EventQuery getEvents(EventQuery eventQuery) throws AttivioException
Executes the event query. IfEventQuery.getMaxFetchSize()
is > 0, multiple calls might be needed to get all the events. In that case,getEvents()
should be called untilEventQuery.isDone()
returnstrue
. Note that the last call might return an empty list. An exception is thrown ifgetEvents()
is called afterEventQuery.isDone()
.EventQuery eventQuery = new EventQuery(); eventQuery.setSubsystem(subsystem); eventQuery.setStart(start); eventQuery.setEnd(end); eventQuery.setGetAlreadyAcknowledged(getAcknoledeged); eventQuery.setMaxFetchSize(maxFetchSize); while (!eventQuery.isDone()) { eventQuery = eventStore().getEvents(eventQuery); // Do something with eventQuery.getEventList() }
- Parameters:
eventQuery
- the caller must pass the EventQuery object returned from the previous call- Returns:
- the query object to be used in the next getEvents call
- Throws:
AttivioException
-
acknowledgeEvent
void acknowledgeEvent(long eventId, java.lang.String user, java.lang.String reason) throws AttivioException
- Parameters:
eventId
-user
-reason
-- Throws:
AttivioException
-
getEvent
SystemEvent getEvent(long eventId) throws AttivioException
- Parameters:
eventId
-- Returns:
- the SystemEvent for the eventId
- Throws:
AttivioException
-
countEvents
long countEvents() throws AttivioException
- Returns:
- the number of stored events
- Throws:
AttivioException
-
-