org.keycloak.models

Interface ClientProvider

All Superinterfaces:

ClientLookupProvider, Provider

All Known Subinterfaces:

CacheRealmProvider, RealmProvider

All Known Implementing Classes:

ClientStorageManager, JpaRealmProvider, MapClientProvider, RealmCacheSession

public interface ClientProvider
extends ClientLookupProvider, Provider

Provider of the client records.

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
default ClientModel	addClient(RealmModel realm, String clientId) Adds a client with given clientId to the given realm.
ClientModel	addClient(RealmModel realm, String id, String clientId) Adds a client with given internal ID and clientId to the given realm.
List<ClientModel>	getAlwaysDisplayInConsoleClients(RealmModel realm) Returns a list of clients that are expected to always show up in account console.
default List<ClientModel>	getClients(RealmModel realm) Returns all the clients of the given realm.
List<ClientModel>	getClients(RealmModel realm, Integer firstResult, Integer maxResults) Returns the clients of the given realm.
long	getClientsCount(RealmModel realm) Returns number of clients in the given realm
boolean	removeClient(RealmModel realm, String id) Removes given client from the given realm.
default boolean	removeClient(String id, RealmModel realm) Deprecated. Use removeClient(RealmModel, String) instead.
void	removeClients(RealmModel realm) Removes all clients from the given realm.

Methods inherited from interface org.keycloak.storage.client.ClientLookupProvider

getClientByClientId, getClientByClientId, getClientById, getClientById, searchClientsByClientId, searchClientsByClientId

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

getClients

List<ClientModel> getClients(RealmModel realm,
                             Integer firstResult,
                             Integer maxResults)

Returns the clients of the given realm.

Parameters:

realm - Realm.

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

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

Returns:

List of the clients. Never returns null.

getClients

default List<ClientModel> getClients(RealmModel realm)

Returns all the clients of the given realm. Effectively the same as the call getClients(realm, null, null).

Parameters:

realm - Realm.

Returns:

List of the clients. Never returns null.

addClient

default ClientModel addClient(RealmModel realm,
                              String clientId)

Adds a client with given clientId to the given realm. The internal ID of the client will be created automatically.

Parameters:

realm - Realm owning this client.

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

Returns:

Model of the created client.

addClient

ClientModel addClient(RealmModel realm,
                      String id,
                      String clientId)

Adds a client with given internal ID and clientId to the given realm.

Parameters:

realm - Realm owning this client.

id - Internal ID of the client or null if one is to be created by the underlying store

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

Returns:

Model of the created client.

Throws:

IllegalArgumentException - If id does not conform the format understood by the underlying store.

getClientsCount

long getClientsCount(RealmModel realm)

Returns number of clients in the given realm

Parameters:

realm - Realm.

Returns:

Number of the clients in the given realm.

getAlwaysDisplayInConsoleClients

List<ClientModel> getAlwaysDisplayInConsoleClients(RealmModel realm)

Returns a list of clients that are expected to always show up in account console.

Parameters:

realm - Realm owning the clients.

Returns:

List of the clients. Never returns null.

removeClient

default boolean removeClient(String id,
                             RealmModel realm)

Deprecated. Use removeClient(RealmModel, String) instead.

Removes given client from the given realm.

Parameters:

id - Internal ID of the client

realm - Realm.

Returns:

true if the client existed and has been removed, false otherwise.

removeClient

boolean removeClient(RealmModel realm,
                     String id)

Removes given client from the given realm.

Parameters:

realm - Realm.

id - Internal ID of the client

Returns:

true if the client existed and has been removed, false otherwise.

removeClients

void removeClients(RealmModel realm)

Removes all clients from the given realm.

Parameters:

realm - Realm.