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

Modifier and Type	Method	Description
ClientModel	addClient(RealmModel realm, String clientId)
ClientModel	addClient(RealmModel realm, String id, String clientId)
void	addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)
void	addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope)
void	close()
Map<ClientModel,Set<String>>	getAllRedirectUrisOfEnabledClients(RealmModel realm)
Stream<ClientModel>	getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
ClientModel	getClientByClientId(RealmModel realm, String clientId)
ClientModel	getClientById(RealmModel realm, String id)
Map<String,ClientScopeModel>	getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)
long	getClientsCount(RealmModel realm)
Stream<ClientModel>	getClientsStream(RealmModel realm)
Stream<ClientModel>	getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)
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)
void	removeClients(RealmModel realm)
void	removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)
Stream<ClientModel>	searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	searchClientsByAuthenticationFlowBindingOverrides(RealmModel realm, Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)

Methods inherited from class java.lang.Object

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

Field Details

session

protected KeycloakSession session

Constructor Details

ClientStorageManager

public ClientStorageManager(KeycloakSession session,
 long clientStorageProviderTimeout)

Method Details

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)

Specified by:

getClientById in interface ClientLookupProvider

getClientByClientId

public ClientModel getClientByClientId(RealmModel realm,
 String clientId)

Specified by:

getClientByClientId in interface ClientLookupProvider

searchClientsByClientIdStream

public Stream<ClientModel> searchClientsByClientIdStream(RealmModel realm,
 String clientId,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchClientsByClientIdStream in interface ClientLookupProvider

searchClientsByAttributes

public Stream<ClientModel> searchClientsByAttributes(RealmModel realm,
 Map<String,String> attributes,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchClientsByAttributes in interface ClientLookupProvider

searchClientsByAuthenticationFlowBindingOverrides

public Stream<ClientModel> searchClientsByAuthenticationFlowBindingOverrides(RealmModel realm,
 Map<String,String> overrides,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchClientsByAuthenticationFlowBindingOverrides in interface ClientLookupProvider

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)

Specified by:

getClientScopes in interface ClientLookupProvider

addClient

public ClientModel addClient(RealmModel realm,
 String clientId)

Specified by:

addClient in interface ClientProvider

addClient

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

Specified by:

addClient in interface ClientProvider

getClientsStream

public Stream<ClientModel> getClientsStream(RealmModel realm,
 Integer firstResult,
 Integer maxResults)

Specified by:

getClientsStream in interface ClientProvider

getClientsStream

public Stream<ClientModel> getClientsStream(RealmModel realm)

Specified by:

getClientsStream in interface ClientProvider

getClientsCount

public long getClientsCount(RealmModel realm)

Specified by:

getClientsCount in interface ClientProvider

getAlwaysDisplayInConsoleClientsStream

public Stream<ClientModel> getAlwaysDisplayInConsoleClientsStream(RealmModel realm)

Specified by:

getAlwaysDisplayInConsoleClientsStream in interface ClientProvider

removeClients

public void removeClients(RealmModel realm)

Specified by:

removeClients in interface ClientProvider

addClientScopes

public void addClientScopes(RealmModel realm,
 ClientModel client,
 Set<ClientScopeModel> clientScopes,
 boolean defaultScope)

Specified by:

addClientScopes in interface ClientProvider

removeClientScope

public void removeClientScope(RealmModel realm,
 ClientModel client,
 ClientScopeModel clientScope)

Specified by:

removeClientScope in interface ClientProvider

addClientScopeToAllClients

public void addClientScopeToAllClients(RealmModel realm,
 ClientScopeModel clientScope,
 boolean defaultClientScope)

Specified by:

addClientScopeToAllClients in interface ClientProvider

getAllRedirectUrisOfEnabledClients

public Map<ClientModel,Set<String>> getAllRedirectUrisOfEnabledClients(RealmModel realm)

Specified by:

getAllRedirectUrisOfEnabledClients in interface ClientProvider

close

public void close()

Specified by:

close in interface Provider

removeClient

public boolean removeClient(RealmModel realm,
 String id)

Specified by:

removeClient in interface ClientProvider