org.keycloak.storage.client

Interface ClientLookupProvider

All Known Subinterfaces:

CacheRealmProvider, ClientProvider, ClientStorageProvider, RealmProvider

All Known Implementing Classes:

ClientStorageManager, JpaRealmProvider, MapClientProvider, OpenshiftClientStorageProvider, RealmCacheSession

public interface ClientLookupProvider

Abstraction interface for lookoup of clients by id and clientId. These methods required for participating in login flows.

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
ClientModel	getClientByClientId(RealmModel realm, String clientId) Exact search for a client by its public client identifier.
default ClientModel	getClientByClientId(String clientId, RealmModel realm) Deprecated. Use getClientByClientId(org.keycloak.models.RealmModel, java.lang.String) instead.
ClientModel	getClientById(RealmModel realm, String id) Exact search for a client by its internal ID.
default ClientModel	getClientById(String id, RealmModel realm) Deprecated. Use getClientById(org.keycloak.models.RealmModel, java.lang.String) instead.
List<ClientModel>	searchClientsByClientId(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Case-insensitive search for clients that contain the given string in their public client identifier.
default List<ClientModel>	searchClientsByClientId(String clientId, Integer firstResult, Integer maxResults, RealmModel realm) Deprecated. Use searchClientsByClientId(org.keycloak.models.RealmModel, java.lang.String, java.lang.Integer, java.lang.Integer) instead.

Method Detail

getClientById

ClientModel getClientById(RealmModel realm,
                          String id)

Exact search for a client by its internal ID.

Parameters:

realm - Realm to limit the search.

id - Internal ID

Returns:

Model of the client, or null if no client is found.

getClientById

default ClientModel getClientById(String id,
                                  RealmModel realm)

Deprecated. Use getClientById(org.keycloak.models.RealmModel, java.lang.String) instead.

Exact search for a client by its internal ID.

Parameters:

realm - Realm to limit the search.

id - Internal ID

Returns:

Model of the client, or null if no client is found.

getClientByClientId

ClientModel getClientByClientId(RealmModel realm,
                                String clientId)

Exact search for a client by its public client identifier.

Parameters:

realm - Realm to limit the search for clients.

clientId - String that identifies the client to the external parties. Maps to client_id in OIDC or entityID in SAML.

Returns:

Model of the client, or null if no client is found.

getClientByClientId

default ClientModel getClientByClientId(String clientId,
                                        RealmModel realm)

Deprecated. Use getClientByClientId(org.keycloak.models.RealmModel, java.lang.String) instead.

Exact search for a client by its public client identifier.

Parameters:

realm - Realm to limit the search.

clientId - String that identifies the client to the external parties. Maps to client_id in OIDC or entityID in SAML.

Returns:

Model of the client, or null if no client is found.

searchClientsByClientId

List<ClientModel> searchClientsByClientId(RealmModel realm,
                                          String clientId,
                                          Integer firstResult,
                                          Integer maxResults)

Case-insensitive search for clients that contain the given string in their public client identifier.

Parameters:

realm - Realm to limit the search for clients.

clientId - Searched substring of the public client identifier (client_id in OIDC or entityID in SAML.)

firstResult - First result to return. Ignored if negative or null.

maxResults - Maximim number of results to return. Ignored if negative or null.

Returns:

Model of the client, or null if no client is found.

searchClientsByClientId

default List<ClientModel> searchClientsByClientId(String clientId,
                                                  Integer firstResult,
                                                  Integer maxResults,
                                                  RealmModel realm)

Deprecated. Use searchClientsByClientId(org.keycloak.models.RealmModel, java.lang.String, java.lang.Integer, java.lang.Integer) instead.

Case-insensitive search for clients that contain the given string in their public client identifier.

Parameters:

realm - Realm to limit the search for clients.

clientId - Searched substring of the public client identifier (client_id in OIDC or entityID in SAML.)

firstResult - First result to return. Ignored if negative or null.

maxResults - Maximim number of results to return. Ignored if negative or null.

Returns:

Models of the matching clients. Never returns null.