Package com.atlassian.crowd.event

Class EventStoreGeneric

java.lang.Object
com.atlassian.crowd.event.EventStoreGeneric
All Implemented Interfaces:
EventStore
public final class EventStoreGeneric extends Object implements EventStore
Thread-safe EventStore implementation that uses main memory as a backing store. The amount of events stored is fixed, and after reaching the limit, the oldest events will start to get dropped.

  • Constructor Details

    • EventStoreGeneric

      public EventStoreGeneric(long maxStoredEvents)
      Creates a new EventStoreGeneric instance.
      Parameters:
      maxStoredEvents - maximum amount of events to keep in the memory

  • Method Details

    • getCurrentEventToken

      public String getCurrentEventToken(List<Long> directoryIds)
      Description copied from interface: EventStore
      Returns a token that can be used for querying events that have happened after the token was generated.

      If the event token has not changed since the last call to this method, it is guaranteed that no new events have been received.

      The format of event token is implementation specific and can change without a warning.

      Specified by:
      getCurrentEventToken in interface EventStore
      Parameters:
      directoryIds - the ids of directories that the token should include events for
      Returns:
      token that can be used for querying events that have happened after the token was generated.

    • getNewEvents

      public Events getNewEvents(String eventToken, List<Long> directoryIds) throws EventTokenExpiredException
      Description copied from interface: EventStore
      Returns an events object which contains a new eventToken and events that happened after the given eventToken was generated.

      If for any reason event store is unable to retrieve events that happened after the event token was generated, an EventTokenExpiredException will be thrown. The caller is then expected to call EventStore.getCurrentEventToken(List) again before asking for new events.

      Specified by:
      getNewEvents in interface EventStore
      Parameters:
      eventToken - event token that was retrieved by a call to EventStore.getCurrentEventToken(List) or EventStore.getNewEvents(String, List)
      directoryIds - the ids of directories to retrieve events for
      Returns:
      events object which contains a new eventToken and events that happened after the given eventToken was generated.
      Throws:
      EventTokenExpiredException - if events that happened after the event token was generated can not be retrieved

    • getNewEvents

      public Events getNewEvents(String eventToken, Application application) throws EventTokenExpiredException
      Description copied from interface: EventStore
      Returns an events object which contains a new eventToken and events that happened after the given eventToken was generated.

      If for any reason event store is unable to retrieve events that happened after the event token was generated, an EventTokenExpiredException will be thrown. The caller is then expected to call EventStore.getCurrentEventToken(List) again before asking for new events.

      Specified by:
      getNewEvents in interface EventStore
      Parameters:
      eventToken - event token that was retrieved by a call to EventStore.getCurrentEventToken(List) or EventStore.getNewEvents(String, List)
      application - the application to retrieve events for
      Returns:
      events object which contains a new eventToken and events that happened after the given eventToken was generated.
      Throws:
      EventTokenExpiredException - if events that happened after the event token was generated can not be retrieved

    • storeOperationEvent

      public void storeOperationEvent(OperationEvent event)
      Description copied from interface: EventStore
      Stores the given event. Implementations MIGHT limit the amount of events stored, and MIGHT not store the event at all if it can be recreated by other means.
      Specified by:
      storeOperationEvent in interface EventStore
      Parameters:
      event - event to be stored

    • handleApplicationEvent

      public void handleApplicationEvent(Object event)
      Description copied from interface: EventStore
      Notifies the store that an application event happened that might make it impossible to recreate the event stream. Depending on the implementation the store MIGHT remove all relevant events, or mark them as invalid. After the call the store MUST NOT present an event stream that might not be valid as a result of the event.
      Specified by:
      handleApplicationEvent in interface EventStore
      Parameters:
      event - the atlassian-events event triggering the action