Package org.keycloak.events.admin
Interface AdminEventQuery
-
- All Known Implementing Classes:
JpaAdminEventQuery
public interface AdminEventQuery
- Author:
- Stian Thorgersen
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description AdminEventQuery
authClient(String clientId)
Search by authenticated clientAdminEventQuery
authIpAddress(String ipAddress)
Search by request ip addressAdminEventQuery
authRealm(String realmId)
Search by authentication realmAdminEventQuery
authUser(String userId)
Search by authenticated userAdminEventQuery
firstResult(int first)
Used for paginationAdminEventQuery
fromTime(Date fromTime)
Search by events after the specified timedefault List<AdminEvent>
getResultList()
Deprecated.UsegetResultStream
instead.Stream<AdminEvent>
getResultStream()
Executes the query and returns the results as a stream.AdminEventQuery
maxResults(int max)
Use for paginationAdminEventQuery
operation(OperationType... operations)
Search by operation typeAdminEventQuery
realm(String realmId)
Search by resource realmAdminEventQuery
resourcePath(String resourcePath)
Search by resource path.AdminEventQuery
resourceType(ResourceType... resourceTypes)
Search byResourceType
.AdminEventQuery
toTime(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
AdminEventQuery
for method chaining
-
authRealm
AdminEventQuery authRealm(String realmId)
Search by authentication realm- Parameters:
realmId
- realm name- 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 byResourceType
.- 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
AdminEventQuery fromTime(Date fromTime)
Search by events after the specified time- Parameters:
fromTime
- from date- Returns:
this
for method chaining
-
toTime
AdminEventQuery toTime(Date toTime)
Search by events before the specified time- Parameters:
toTime
- to date- 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
-
getResultList
@Deprecated default List<AdminEvent> getResultList()
Deprecated.UsegetResultStream
instead.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
.
-
-