Package org.keycloak.events.jpa

Class JpaEventQuery

java.lang.Object

org.keycloak.events.jpa.JpaEventQuery

All Implemented Interfaces:

EventQuery

public class JpaEventQuery
extends Object
implements EventQuery

Author:

Stian Thorgersen

Constructor Summary

Constructors

Constructor	Description
JpaEventQuery(javax.persistence.EntityManager em)

Method Summary

Modifier and Type	Method	Description
EventQuery	client(String clientId)	Search events for only one client
EventQuery	firstResult(int firstResult)	Index of the first result to return.
EventQuery	fromDate(Date fromDate)	Search events that are newer than fromDate
Stream<Event>	getResultStream()	Returns requested results that match given criteria as a stream.
EventQuery	ipAddress(String ipAddress)	Search events from ipAddress
EventQuery	maxResults(int maxResults)	Maximum number of results to return.
EventQuery	orderByAscTime()	Order the result by ascending time
EventQuery	orderByDescTime()	Order the result by descending time
EventQuery	realm(String realmId)	Search events within realm
EventQuery	toDate(Date toDate)	Search events that are older than toDate
EventQuery	type(EventType... types)	Search events with given types
EventQuery	user(String userId)	Search events for only one user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JpaEventQuery

public JpaEventQuery(javax.persistence.EntityManager em)

Method Detail

type

public EventQuery type(EventType... types)

Description copied from interface: EventQuery

Search events with given types

Specified by:

type in interface EventQuery

Parameters:

types - requested types

Returns:

this object for method chaining

realm

public EventQuery realm(String realmId)

Description copied from interface: EventQuery

Search events within realm

Specified by:

realm in interface EventQuery

Parameters:

realmId - id of realm

Returns:

this object for method chaining

client

public EventQuery client(String clientId)

Description copied from interface: EventQuery

Search events for only one client

Specified by:

client in interface EventQuery

Parameters:

clientId - id of client

Returns:

this object for method chaining

user

public EventQuery user(String userId)

Description copied from interface: EventQuery

Search events for only one user

Specified by:

user in interface EventQuery

Parameters:

userId - id of user

Returns:

this object for method chaining

fromDate

public EventQuery fromDate(Date fromDate)

Description copied from interface: EventQuery

Search events that are newer than fromDate

Specified by:

fromDate in interface EventQuery

Parameters:

fromDate - date

Returns:

this object for method chaining

toDate

public EventQuery toDate(Date toDate)

Description copied from interface: EventQuery

Search events that are older than toDate

Specified by:

toDate in interface EventQuery

Parameters:

toDate - date

Returns:

this object for method chaining

ipAddress

public EventQuery ipAddress(String ipAddress)

Description copied from interface: EventQuery

Search events from ipAddress

Specified by:

ipAddress in interface EventQuery

Parameters:

ipAddress - ip

Returns:

this object for method chaining

firstResult

public EventQuery firstResult(int firstResult)

Description copied from interface: EventQuery

Index of the first result to return.

Specified by:

firstResult in interface EventQuery

Parameters:

firstResult - the index. Ignored if negative.

Returns:

this object for method chaining

maxResults

public EventQuery maxResults(int maxResults)

Description copied from interface: EventQuery

Maximum number of results to return.

Specified by:

maxResults in interface EventQuery

Parameters:

maxResults - a number. Ignored if negative.

Returns:

this object for method chaining

orderByDescTime

public EventQuery orderByDescTime()

Description copied from interface: EventQuery

Order the result by descending time

Specified by:

orderByDescTime in interface EventQuery

Returns:

this for method chaining

orderByAscTime

public EventQuery orderByAscTime()

Description copied from interface: EventQuery

Order the result by ascending time

Specified by:

orderByAscTime in interface EventQuery

Returns:

this for method chaining

getResultStream

public Stream<Event> getResultStream()

Description copied from interface: EventQuery

Returns requested results that match given criteria as a stream.

Specified by:

getResultStream in interface EventQuery

Returns:

Stream of events. Never returns null.