Package org.keycloak.storage
Class ClientStorageManager
- java.lang.Object
-
- org.keycloak.storage.ClientStorageManager
-
- All Implemented Interfaces:
ClientProvider
,Provider
,ClientLookupProvider
public class ClientStorageManager extends Object implements ClientProvider
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description protected KeycloakSession
session
-
Constructor Summary
Constructors Constructor Description ClientStorageManager(KeycloakSession session, long clientStorageProviderTimeout)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ClientModel
addClient(RealmModel realm, String clientId)
Adds a client with givenclientId
to the given realm.ClientModel
addClient(RealmModel realm, String id, String clientId)
Adds a client with given internal ID andclientId
to the given realm.void
addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)
Assign clientScopes to the client.void
close()
Map<ClientModel,Set<String>>
getAllRedirectUrisOfEnabledClients(RealmModel realm)
Returns a map of (rootUrl, {validRedirectUris}) for all enabled clients.Stream<ClientModel>
getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
Returns a stream of clients that are expected to always show up in account console.ClientModel
getClientByClientId(RealmModel realm, String clientId)
Exact search for a client by its public client identifier.ClientModel
getClientById(RealmModel realm, String id)
Exact search for a client by its internal ID.Map<String,ClientScopeModel>
getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)
Return all default scopes (ifdefaultScope
istrue
) or all optional scopes (ifdefaultScope
isfalse
) linked with the clientlong
getClientsCount(RealmModel realm)
Returns number of clients in the given realmStream<ClientModel>
getClientsStream(RealmModel realm)
Returns all the clients of the given realm as a stream.Stream<ClientModel>
getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)
Returns the clients of the given realm as a stream.static <T> Stream<T>
getEnabledStorageProviders(KeycloakSession session, RealmModel realm, Class<T> type)
static ClientStorageProvider
getStorageProvider(KeycloakSession session, RealmModel realm, String componentId)
static ClientStorageProvider
getStorageProviderInstance(KeycloakSession session, ClientStorageProviderModel model, ClientStorageProviderFactory factory)
static ClientStorageProviderModel
getStorageProviderModel(RealmModel realm, String componentId)
static <T> Stream<T>
getStorageProviders(KeycloakSession session, RealmModel realm, Class<T> type)
static boolean
hasEnabledStorageProviders(KeycloakSession session, RealmModel realm, Class<?> type)
static boolean
isStorageProviderEnabled(RealmModel realm, String providerId)
protected Stream<ClientModel>
query(org.keycloak.storage.ClientStorageManager.PaginatedQuery paginatedQuery, RealmModel realm, Integer firstResult, Integer maxResults)
boolean
removeClient(RealmModel realm, String id)
Removes given client from the given realm.void
removeClients(RealmModel realm)
Removes all clients from the given realm.void
removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)
Unassign clientScope from the client.Stream<ClientModel>
searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>
searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)
Case-insensitive search for clients that contain the given string in their public client identifier.
-
-
-
Field Detail
-
session
protected KeycloakSession session
-
-
Constructor Detail
-
ClientStorageManager
public ClientStorageManager(KeycloakSession session, long clientStorageProviderTimeout)
-
-
Method Detail
-
isStorageProviderEnabled
public static boolean isStorageProviderEnabled(RealmModel realm, String providerId)
-
getStorageProviderModel
public static ClientStorageProviderModel getStorageProviderModel(RealmModel realm, String componentId)
-
getStorageProvider
public static ClientStorageProvider getStorageProvider(KeycloakSession session, RealmModel realm, String componentId)
-
getStorageProviderInstance
public static ClientStorageProvider getStorageProviderInstance(KeycloakSession session, ClientStorageProviderModel model, ClientStorageProviderFactory factory)
-
getStorageProviders
public static <T> Stream<T> getStorageProviders(KeycloakSession session, RealmModel realm, Class<T> type)
-
getEnabledStorageProviders
public static <T> Stream<T> getEnabledStorageProviders(KeycloakSession session, RealmModel realm, Class<T> type)
-
hasEnabledStorageProviders
public static boolean hasEnabledStorageProviders(KeycloakSession session, RealmModel realm, Class<?> type)
-
getClientById
public ClientModel getClientById(RealmModel realm, String id)
Description copied from interface:ClientLookupProvider
Exact search for a client by its internal ID.- Specified by:
getClientById
in interfaceClientLookupProvider
- Parameters:
realm
- Realm to limit the search.id
- Internal ID- Returns:
- Model of the client, or
null
if no client is found.
-
getClientByClientId
public ClientModel getClientByClientId(RealmModel realm, String clientId)
Description copied from interface:ClientLookupProvider
Exact search for a client by its public client identifier.- Specified by:
getClientByClientId
in interfaceClientLookupProvider
- Parameters:
realm
- Realm to limit the search for clients.clientId
- String that identifies the client to the external parties. Maps toclient_id
in OIDC orentityID
in SAML.- Returns:
- Model of the client, or
null
if no client is found.
-
searchClientsByClientIdStream
public Stream<ClientModel> searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)
Description copied from interface:ClientLookupProvider
Case-insensitive search for clients that contain the given string in their public client identifier.- Specified by:
searchClientsByClientIdStream
in interfaceClientLookupProvider
- Parameters:
realm
- Realm to limit the search for clients.clientId
- Searched substring of the public client identifier (client_id
in OIDC orentityID
in SAML.)firstResult
- First result to return. Ignored if negative ornull
.maxResults
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
- Stream of ClientModel or an empty stream if no client is found. Never returns
null
.
-
searchClientsByAttributes
public Stream<ClientModel> searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
- Specified by:
searchClientsByAttributes
in interfaceClientLookupProvider
-
query
protected Stream<ClientModel> query(org.keycloak.storage.ClientStorageManager.PaginatedQuery paginatedQuery, RealmModel realm, Integer firstResult, Integer maxResults)
-
getClientScopes
public Map<String,ClientScopeModel> getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)
Description copied from interface:ClientLookupProvider
Return all default scopes (ifdefaultScope
istrue
) or all optional scopes (ifdefaultScope
isfalse
) linked with the client- Specified by:
getClientScopes
in interfaceClientLookupProvider
- Parameters:
realm
- Realmclient
- ClientdefaultScopes
- if true default scopes, if false optional scopes, are returned- Returns:
- map where key is the name of the clientScope, value is particular clientScope. Returns empty map if no scopes linked (never returns null).
-
addClient
public ClientModel addClient(RealmModel realm, String clientId)
Description copied from interface:ClientProvider
Adds a client with givenclientId
to the given realm. The internal ID of the client will be created automatically.- Specified by:
addClient
in interfaceClientProvider
- Parameters:
realm
- Realm owning this client.clientId
- String that identifies the client to the external parties. Maps toclient_id
in OIDC orentityID
in SAML.- Returns:
- Model of the created client.
-
addClient
public ClientModel addClient(RealmModel realm, String id, String clientId)
Description copied from interface:ClientProvider
Adds a client with given internal ID andclientId
to the given realm.- Specified by:
addClient
in interfaceClientProvider
- Parameters:
realm
- Realm owning this client.id
- Internal ID of the client ornull
if one is to be created by the underlying storeclientId
- String that identifies the client to the external parties. Maps toclient_id
in OIDC orentityID
in SAML.- Returns:
- Model of the created client.
-
getClientsStream
public Stream<ClientModel> getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)
Description copied from interface:ClientProvider
Returns the clients of the given realm as a stream.- Specified by:
getClientsStream
in interfaceClientProvider
- Parameters:
realm
- Realm.firstResult
- First result to return. Ignored if negative ornull
.maxResults
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
- Stream of the clients. Never returns
null
.
-
getClientsStream
public Stream<ClientModel> getClientsStream(RealmModel realm)
Description copied from interface:ClientProvider
Returns all the clients of the given realm as a stream. Effectively the same as the callgetClientsStream(realm, null, null)
.- Specified by:
getClientsStream
in interfaceClientProvider
- Parameters:
realm
- Realm.- Returns:
- Stream of the clients. Never returns
null
.
-
getClientsCount
public long getClientsCount(RealmModel realm)
Description copied from interface:ClientProvider
Returns number of clients in the given realm- Specified by:
getClientsCount
in interfaceClientProvider
- Parameters:
realm
- Realm.- Returns:
- Number of the clients in the given realm.
-
getAlwaysDisplayInConsoleClientsStream
public Stream<ClientModel> getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
Description copied from interface:ClientProvider
Returns a stream of clients that are expected to always show up in account console.- Specified by:
getAlwaysDisplayInConsoleClientsStream
in interfaceClientProvider
- Parameters:
realm
- Realm owning the clients.- Returns:
- Stream of the clients. Never returns
null
.
-
removeClients
public void removeClients(RealmModel realm)
Description copied from interface:ClientProvider
Removes all clients from the given realm.- Specified by:
removeClients
in interfaceClientProvider
- Parameters:
realm
- Realm.
-
addClientScopes
public void addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)
Description copied from interface:ClientProvider
Assign clientScopes to the client. Add as default scopes (if parameter 'defaultScope' is true) or optional scopes (if parameter 'defaultScope' is false)- Specified by:
addClientScopes
in interfaceClientProvider
- Parameters:
realm
- Realm.client
- Client.clientScopes
- to be assigneddefaultScope
- if true the scopes are assigned as default, or optional in case of false
-
removeClientScope
public void removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)
Description copied from interface:ClientProvider
Unassign clientScope from the client.- Specified by:
removeClientScope
in interfaceClientProvider
- Parameters:
realm
- Realm.client
- Client.clientScope
- to be unassigned
-
getAllRedirectUrisOfEnabledClients
public Map<ClientModel,Set<String>> getAllRedirectUrisOfEnabledClients(RealmModel realm)
Description copied from interface:ClientProvider
Returns a map of (rootUrl, {validRedirectUris}) for all enabled clients.- Specified by:
getAllRedirectUrisOfEnabledClients
in interfaceClientProvider
- Returns:
-
removeClient
public boolean removeClient(RealmModel realm, String id)
Description copied from interface:ClientProvider
Removes given client from the given realm.- Specified by:
removeClient
in interfaceClientProvider
- Parameters:
realm
- Realm.id
- Internal ID of the client- Returns:
true
if the client existed and has been removed,false
otherwise.
-
-