Package org.keycloak.events.admin
Interface AdminEventQuery
-
public interface AdminEventQuery- Author:
- Stian Thorgersen
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description AdminEventQueryauthClient(String clientId)Search by authenticated clientAdminEventQueryauthIpAddress(String ipAddress)Search by request ip addressAdminEventQueryauthRealm(String realmId)Search by authentication realmAdminEventQueryauthUser(String userId)Search by authenticated userAdminEventQueryfirstResult(int first)Used for paginationAdminEventQueryfromTime(Date fromTime)Search by events after the specified timedefault List<AdminEvent>getResultList()Deprecated.UsegetResultStreaminstead.Stream<AdminEvent>getResultStream()Executes the query and returns the results as a stream.AdminEventQuerymaxResults(int max)Use for paginationAdminEventQueryoperation(OperationType... operations)Search by operation typeAdminEventQueryrealm(String realmId)Search by resource realmAdminEventQueryresourcePath(String resourcePath)Search by resource path.AdminEventQueryresourceType(ResourceType... resourceTypes)Search byResourceType.AdminEventQuerytoTime(Date toTime)Search by events before the specified time
-
-
-
Method Detail
-
realm
AdminEventQuery realm(String realmId)
Search by resource realm- Parameters:
realmId- realm id- Returns:
- Associated
AdminEventQueryfor method chaining
-
authRealm
AdminEventQuery authRealm(String realmId)
Search by authentication realm- Parameters:
realmId- realm name- Returns:
- Associated
AdminEventQueryfor method chaining
-
authClient
AdminEventQuery authClient(String clientId)
Search by authenticated client- Parameters:
clientId- client uuid- Returns:
- Associated
AdminEventQueryfor method chaining
-
authUser
AdminEventQuery authUser(String userId)
Search by authenticated user- Parameters:
userId- user uuid- Returns:
- Associated
AdminEventQueryfor method chaining
-
authIpAddress
AdminEventQuery authIpAddress(String ipAddress)
Search by request ip address- Parameters:
ipAddress-- Returns:
- Associated
AdminEventQueryfor method chaining
-
operation
AdminEventQuery operation(OperationType... operations)
Search by operation type- Parameters:
operations-- Returns:
thisfor method chaining
-
resourceType
AdminEventQuery resourceType(ResourceType... resourceTypes)
Search byResourceType.- Parameters:
resourceTypes-- Returns:
thisfor 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:
thisfor method chaining
-
fromTime
AdminEventQuery fromTime(Date fromTime)
Search by events after the specified time- Parameters:
fromTime- from date- Returns:
thisfor method chaining
-
toTime
AdminEventQuery toTime(Date toTime)
Search by events before the specified time- Parameters:
toTime- to date- Returns:
thisfor method chaining
-
firstResult
AdminEventQuery firstResult(int first)
Used for pagination- Parameters:
first- first result to return- Returns:
thisfor method chaining
-
maxResults
AdminEventQuery maxResults(int max)
Use for pagination- Parameters:
max- the maximum results to return- Returns:
thisfor method chaining
-
getResultList
@Deprecated default List<AdminEvent> getResultList()
Deprecated.UsegetResultStreaminstead.Executes the query and returns the results
-
getResultStream
Stream<AdminEvent> getResultStream()
Executes the query and returns the results as a stream.- Returns:
- Stream of admin events. Never returns
null.
-
-