Package org.keycloak.events.admin
Interface AdminEventQuery
- 
- All Known Implementing Classes:
- JpaAdminEventQuery,- MapAdminEventQuery
 
 public interface AdminEventQuery- Author:
- Stian Thorgersen
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract 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 timeStream<AdminEvent>getResultStream()Executes the query and returns the results as a stream.AdminEventQuerymaxResults(int max)Use for paginationAdminEventQueryoperation(OperationType... operations)Search by operation typeAdminEventQueryorderByAscTime()Order the result by ascending timeAdminEventQueryorderByDescTime()Order the result by descending timeAdminEventQueryrealm(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- 
realmAdminEventQuery realm(String realmId) Search by resource realm- Parameters:
- realmId- realm id
- Returns:
- Associated AdminEventQueryfor method chaining
 
 - 
authRealmAdminEventQuery authRealm(String realmId) Search by authentication realm- Parameters:
- realmId- realm id
- Returns:
- Associated AdminEventQueryfor method chaining
 
 - 
authClientAdminEventQuery authClient(String clientId) Search by authenticated client- Parameters:
- clientId- client uuid
- Returns:
- Associated AdminEventQueryfor method chaining
 
 - 
authUserAdminEventQuery authUser(String userId) Search by authenticated user- Parameters:
- userId- user uuid
- Returns:
- Associated AdminEventQueryfor method chaining
 
 - 
authIpAddressAdminEventQuery authIpAddress(String ipAddress) Search by request ip address- Parameters:
- ipAddress-
- Returns:
- Associated AdminEventQueryfor method chaining
 
 - 
operationAdminEventQuery operation(OperationType... operations) Search by operation type- Parameters:
- operations-
- Returns:
- thisfor method chaining
 
 - 
resourceTypeAdminEventQuery resourceType(ResourceType... resourceTypes) Search byResourceType.- Parameters:
- resourceTypes-
- Returns:
- thisfor method chaining
 
 - 
resourcePathAdminEventQuery 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
 
 - 
fromTimeAdminEventQuery fromTime(Date fromTime) Search by events after the specified time- Parameters:
- fromTime- from date
- Returns:
- thisfor method chaining
 
 - 
toTimeAdminEventQuery toTime(Date toTime) Search by events before the specified time- Parameters:
- toTime- to date
- Returns:
- thisfor method chaining
 
 - 
firstResultAdminEventQuery firstResult(int first) Used for pagination- Parameters:
- first- first result to return
- Returns:
- thisfor method chaining
 
 - 
maxResultsAdminEventQuery maxResults(int max) Use for pagination- Parameters:
- max- the maximum results to return
- Returns:
- thisfor method chaining
 
 - 
orderByDescTimeAdminEventQuery orderByDescTime() Order the result by descending time- Returns:
- thisfor method chaining
 
 - 
orderByAscTimeAdminEventQuery orderByAscTime() Order the result by ascending time- Returns:
- thisfor method chaining
 
 - 
getResultStreamStream<AdminEvent> getResultStream() Executes the query and returns the results as a stream.- Returns:
- Stream of admin events. Never returns null.
 
 
- 
 
-