org.keycloak.federation.ldap.idm.query.internal

Class DefaultQueryBuilder

java.lang.Object

org.keycloak.federation.ldap.idm.query.internal.DefaultQueryBuilder

All Implemented Interfaces:

IdentityQueryBuilder

public class DefaultQueryBuilder
extends Object
implements IdentityQueryBuilder

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
DefaultQueryBuilder(IdentityStore identityStore)

Method Summary

Methods

Modifier and Type	Method and Description
Sort	asc(QueryParameter parameter) Create an ascending order for the given parameter.
Condition	between(QueryParameter parameter, Object x, Object y) Create a condition for testing whether the query parameter is between the given values.
<T extends IdentityType> IdentityQuery	createIdentityQuery(Class<T> identityType) Create an IdentityQuery that can be used to query for IdentityType instances of a the given identityType.
Sort	desc(QueryParameter parameter) Create an descending order for the given parameter.
Condition	equal(QueryParameter parameter, Object value) Create a condition for testing the arguments for equality.
Condition	greaterThan(QueryParameter parameter, Object x) Create a condition for testing whether the query parameter is grater than the given value..
Condition	greaterThanOrEqualTo(QueryParameter parameter, Object x) Create a condition for testing whether the query parameter is grater than or equal to the given value..
Condition	in(QueryParameter parameter, Object... x) Create a condition for testing whether the query parameter is contained in a list of values.
Condition	lessThan(QueryParameter parameter, Object x) Create a condition for testing whether the query parameter is less than the given value..
Condition	lessThanOrEqualTo(QueryParameter parameter, Object x) Create a condition for testing whether the query parameter is less than or equal to the given value..
Condition	like(QueryParameter parameter, String pattern) Create a condition for testing the whether the query parameter satisfies the given pattern..

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultQueryBuilder

public DefaultQueryBuilder(IdentityStore identityStore)

Method Detail

like

public Condition like(QueryParameter parameter,
             String pattern)

Description copied from interface: IdentityQueryBuilder

Create a condition for testing the whether the query parameter satisfies the given pattern..

Specified by:

like in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter.

pattern - The pattern to match.

Returns:

equal

public Condition equal(QueryParameter parameter,
              Object value)

Description copied from interface: IdentityQueryBuilder

Create a condition for testing the arguments for equality.

Specified by:

equal in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter.

value - The value to compare.

Returns:

greaterThan

public Condition greaterThan(QueryParameter parameter,
                    Object x)

Description copied from interface: IdentityQueryBuilder

Create a condition for testing whether the query parameter is grater than the given value..

Specified by:

greaterThan in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter.

x - The value to compare.

Returns:

greaterThanOrEqualTo

public Condition greaterThanOrEqualTo(QueryParameter parameter,
                             Object x)

Description copied from interface: IdentityQueryBuilder

Create a condition for testing whether the query parameter is grater than or equal to the given value..

Specified by:

greaterThanOrEqualTo in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter.

x - The value to compare.

Returns:

lessThan

public Condition lessThan(QueryParameter parameter,
                 Object x)

Description copied from interface: IdentityQueryBuilder

Create a condition for testing whether the query parameter is less than the given value..

Specified by:

lessThan in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter.

x - The value to compare.

Returns:

lessThanOrEqualTo

public Condition lessThanOrEqualTo(QueryParameter parameter,
                          Object x)

Description copied from interface: IdentityQueryBuilder

Create a condition for testing whether the query parameter is less than or equal to the given value..

Specified by:

lessThanOrEqualTo in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter.

x - The value to compare.

Returns:

between

public Condition between(QueryParameter parameter,
                Object x,
                Object y)

Description copied from interface: IdentityQueryBuilder

Create a condition for testing whether the query parameter is between the given values.

Specified by:

between in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter.

x - The first value.

Returns:

in

public Condition in(QueryParameter parameter,
           Object... x)

Description copied from interface: IdentityQueryBuilder

Create a condition for testing whether the query parameter is contained in a list of values.

Specified by:

in in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter.

x - A list of values.

Returns:

asc

public Sort asc(QueryParameter parameter)

Description copied from interface: IdentityQueryBuilder

Create an ascending order for the given parameter. Once created, you can use it to sort the results of a query.

Specified by:

asc in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter to sort.

Returns:

desc

public Sort desc(QueryParameter parameter)

Description copied from interface: IdentityQueryBuilder

Create an descending order for the given parameter. Once created, you can use it to sort the results of a query.

Specified by:

desc in interface IdentityQueryBuilder

Parameters:

parameter - The query parameter to sort.

Returns:

createIdentityQuery

public <T extends IdentityType> IdentityQuery createIdentityQuery(Class<T> identityType)

Description copied from interface: IdentityQueryBuilder

Create an IdentityQuery that can be used to query for IdentityType instances of a the given identityType.

Specified by:

createIdentityQuery in interface IdentityQueryBuilder

Parameters:

identityType - The type to search. If you provide the IdentityType base interface any of its sub-types will be returned.

Returns: