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 and Description
protected KeycloakSession	session

Constructor Summary

Constructors

Constructor and Description
ClientStorageManager(KeycloakSession session)

Method Summary

Modifier and Type	Method and Description
ClientModel	addClient(RealmModel realm, String clientId)
ClientModel	addClient(RealmModel realm, String id, String clientId)
void	close()
List<ClientModel>	getAlwaysDisplayInConsoleClients(RealmModel realm)
ClientModel	getClientByClientId(RealmModel realm, String clientId)
ClientModel	getClientById(RealmModel realm, String id)
List<ClientModel>	getClients(RealmModel realm)
List<ClientModel>	getClients(RealmModel realm, Integer firstResult, Integer maxResults)
long	getClientsCount(RealmModel realm)
static <T> List<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> List<T>	getStorageProviders(KeycloakSession session, RealmModel realm, Class<T> type)
static List<ClientStorageProviderModel>	getStorageProviders(RealmModel realm)
static boolean	isStorageProviderEnabled(RealmModel realm, String providerId)
boolean	removeClient(RealmModel realm, String id)
void	removeClients(RealmModel realm)
List<ClientModel>	searchClientsByClientId(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

Methods inherited from interface org.keycloak.models.ClientProvider

removeClient

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

getClientByClientId, getClientById, searchClientsByClientId

Field Detail

session

protected KeycloakSession session

Constructor Detail

ClientStorageManager

public ClientStorageManager(KeycloakSession session)

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)

getStorageProviders

public static List<ClientStorageProviderModel> getStorageProviders(RealmModel realm)

getStorageProviderInstance

public static ClientStorageProvider getStorageProviderInstance(KeycloakSession session,
                                                               ClientStorageProviderModel model,
                                                               ClientStorageProviderFactory factory)

getStorageProviders

public static <T> List<T> getStorageProviders(KeycloakSession session,
                                              RealmModel realm,
                                              Class<T> type)

getEnabledStorageProviders

public static <T> List<T> getEnabledStorageProviders(KeycloakSession session,
                                                     RealmModel realm,
                                                     Class<T> 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

searchClientsByClientId

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

Specified by:

searchClientsByClientId 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

getClients

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

Specified by:

getClients in interface ClientProvider

getClients

public List<ClientModel> getClients(RealmModel realm)

Specified by:

getClients in interface ClientProvider

getClientsCount

public long getClientsCount(RealmModel realm)

Specified by:

getClientsCount in interface ClientProvider

getAlwaysDisplayInConsoleClients

public List<ClientModel> getAlwaysDisplayInConsoleClients(RealmModel realm)

Specified by:

getAlwaysDisplayInConsoleClients in interface ClientProvider

removeClients

public void removeClients(RealmModel realm)

Specified by:

removeClients 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