Package org.keycloak.events.admin

Interface AdminEventQuery

All Known Implementing Classes:
JpaAdminEventQuery
public interface AdminEventQuery
Author:
Stian Thorgersen

  • Method Details

    • realm

      AdminEventQuery realm(String realmId)
      Search by resource realm
      Parameters:
      realmId - realm id
      Returns:
      Associated AdminEventQuery for method chaining

    • authRealm

      AdminEventQuery authRealm(String realmId)
      Search by authentication realm
      Parameters:
      realmId - realm id
      Returns:
      Associated AdminEventQuery for method chaining

    • authClient

      AdminEventQuery authClient(String clientId)
      Search by authenticated client
      Parameters:
      clientId - client uuid
      Returns:
      Associated AdminEventQuery for method chaining

    • authUser

      AdminEventQuery authUser(String userId)
      Search by authenticated user
      Parameters:
      userId - user uuid
      Returns:
      Associated AdminEventQuery for method chaining

    • authIpAddress

      AdminEventQuery authIpAddress(String ipAddress)
      Search by request ip address
      Parameters:
      ipAddress -
      Returns:
      Associated AdminEventQuery for method chaining

    • operation

      AdminEventQuery operation(OperationType... operations)
      Search by operation type
      Parameters:
      operations -
      Returns:
      this for method chaining

    • resourceType

      AdminEventQuery resourceType(ResourceType... resourceTypes)
      Search by ResourceType.
      Parameters:
      resourceTypes -
      Returns:
      this for method chaining

    • resourcePath

      AdminEventQuery resourcePath(String resourcePath)
      Search by resource path. Supports wildcard *. For example:
      • */master - matches 'realms/master'
      • realms/master/*/00d4b16f - matches 'realms/master/clients/00d4b16f'
      • realms/master/* - matches anything under 'realms/master'
      Parameters:
      resourcePath -
      Returns:
      this for method chaining

    • fromTime

      @Deprecated AdminEventQuery fromTime(Date fromTime)
      Deprecated.
      Search by events on or after the specified time
      Parameters:
      fromTime - from date
      Returns:
      this for method chaining

    • fromTime

      AdminEventQuery fromTime(long fromTime)
      Search by events on or after the specified timestamp
      Parameters:
      fromTime - from timestamp
      Returns:
      this for method chaining

    • toTime

      @Deprecated AdminEventQuery toTime(Date toTime)
      Deprecated.
      Search by events on or before the specified time
      Parameters:
      toTime - to date
      Returns:
      this for method chaining

    • toTime

      AdminEventQuery toTime(long toTime)
      Search by events on or before the specified timestamp
      Parameters:
      toTime - to timestamp
      Returns:
      this for method chaining

    • firstResult

      AdminEventQuery firstResult(int first)
      Used for pagination
      Parameters:
      first - first result to return
      Returns:
      this for method chaining

    • maxResults

      AdminEventQuery maxResults(int max)
      Use for pagination
      Parameters:
      max - the maximum results to return
      Returns:
      this for method chaining

    • orderByDescTime

      AdminEventQuery orderByDescTime()
      Order the result by descending time
      Returns:
      this for method chaining

    • orderByAscTime

      AdminEventQuery orderByAscTime()
      Order the result by ascending time
      Returns:
      this for method chaining

    • getResultStream

      Stream<AdminEvent> getResultStream()
      Executes the query and returns the results as a stream.
      Returns:
      Stream of admin events. Never returns null.