Package org.keycloak.events

Interface EventStoreProvider

All Superinterfaces:
EventListenerProvider, Provider
All Known Implementing Classes:
JpaEventStoreProvider, MapEventStoreProvider
public interface EventStoreProvider extends EventListenerProvider
Author:
Stian Thorgersen

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Deprecated.
    Unused method.
    void
    clear(RealmModel realm)
    Removes all auth events for the realm from this store provider.
    void
    clear(RealmModel realm, long olderThan)
    Removes all auth events for the realm that are older than olderThan from this store provider.
    void
    clearAdmin()
    Deprecated.
    Unused method.
    void
    clearAdmin(RealmModel realm)
    Removes all auth events for the realm from this store provider.
    void
    clearAdmin(RealmModel realm, long olderThan)
    Removes all auth events for the realm that are older than olderThan from this store provider.
    void
    clearExpiredEvents()
    Deprecated.
    This method is problem from the performance perspective.
    AdminEventQuery
    createAdminQuery()
    Returns an object representing admin event query of type AdminEventQuery.
    EventQuery
    createQuery()
    Returns an object representing auth event query of type EventQuery.

    Methods inherited from interface org.keycloak.events.EventListenerProvider

    onEvent, onEvent

    Methods inherited from interface org.keycloak.provider.Provider

    close

  • Method Details

    • createQuery

      EventQuery createQuery()
      Returns an object representing auth event query of type EventQuery. The object is used for collecting requested properties of auth events (e.g. realm, operation, resourceType time boundaries, etc.) and contains the EventQuery.getResultStream() method that returns all objects from this store provider that have given properties.
      Returns:
      a query object

    • createAdminQuery

      AdminEventQuery createAdminQuery()
      Returns an object representing admin event query of type AdminEventQuery. The object is used for collecting requested properties of admin events (e.g. realm, operation, resourceType time boundaries, etc.) and contains the AdminEventQuery.getResultStream() method that returns all objects from this store provider that have given properties.
      Returns:
      a query object

    • clear

      void clear()
      Deprecated.
      Unused method. Currently, used only in the testsuite
      Removes all auth events from this store provider.

    • clear

      void clear(RealmModel realm)
      Removes all auth events for the realm from this store provider.
      Parameters:
      realm - the realm

    • clear

      void clear(RealmModel realm, long olderThan)
      Removes all auth events for the realm that are older than olderThan from this store provider.
      Parameters:
      realm - the realm
      olderThan - point in time in milliseconds

    • clearExpiredEvents

      void clearExpiredEvents()
      Deprecated.
      This method is problem from the performance perspective. Some storages can provide better way for doing this (e.g. entry lifespan in the Infinispan server, etc.). We need to leave solving event expiration to each storage provider separately using expiration field on entity level.
      Clears all expired events in all realms

    • clearAdmin

      void clearAdmin()
      Deprecated.
      Unused method. Currently, used only in the testsuite
      Removes all admin events from this store provider.

    • clearAdmin

      void clearAdmin(RealmModel realm)
      Removes all auth events for the realm from this store provider.
      Parameters:
      realm - the realm

    • clearAdmin

      void clearAdmin(RealmModel realm, long olderThan)
      Removes all auth events for the realm that are older than olderThan from this store provider.
      Parameters:
      realm - the realm
      olderThan - point in time in milliseconds