Package org.keycloak.storage

Class RoleStorageManager

java.lang.Object

org.keycloak.storage.RoleStorageManager

All Implemented Interfaces:

RoleProvider, Provider, RoleLookupProvider

public class RoleStorageManager
extends Object
implements RoleProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
RoleStorageManager(KeycloakSession session, long roleStorageProviderTimeout)

Method Summary

Modifier and Type	Method	Description
RoleModel	addClientRole(ClientModel client, String name)
RoleModel	addClientRole(ClientModel client, String id, String name)
RoleModel	addRealmRole(RealmModel realm, String name)
RoleModel	addRealmRole(RealmModel realm, String id, String name)
void	close()
RoleModel	getClientRole(ClientModel client, String name)
Stream<RoleModel>	getClientRolesStream(ClientModel client)
Stream<RoleModel>	getClientRolesStream(ClientModel client, Integer first, Integer max)
static <T> Stream<T>	getEnabledStorageProviders(KeycloakSession session, RealmModel realm, Class<T> type)
RoleModel	getRealmRole(RealmModel realm, String name)
Stream<RoleModel>	getRealmRolesStream(RealmModel realm, Integer first, Integer max)
RoleModel	getRoleById(RealmModel realm, String id)
Stream<RoleModel>	getRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
static RoleStorageProvider	getStorageProvider(KeycloakSession session, RealmModel realm, String componentId)
static RoleStorageProvider	getStorageProviderInstance(KeycloakSession session, RoleStorageProviderModel model, RoleStorageProviderFactory factory)
static RoleStorageProviderModel	getStorageProviderModel(RealmModel realm, String componentId)
static <T> Stream<T>	getStorageProviders(KeycloakSession session, RealmModel realm, Class<T> type)
static <T> Stream<RoleStorageProviderModel>	getStorageProviders(RealmModel realm, KeycloakSession session, Class<T> type)
static boolean	isStorageProviderEnabled(RealmModel realm, String providerId)
boolean	removeRole(RoleModel role)
void	removeRoles(ClientModel client)
void	removeRoles(RealmModel realm)
Stream<RoleModel>	searchForClientRolesStream(ClientModel client, String search, Integer first, Integer max)	Obtaining roles from an external role storage is time-bounded.
Stream<RoleModel>	searchForRolesStream(RealmModel realm, String search, Integer first, Integer max)	Obtaining roles from an external role storage is time-bounded.

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.RoleProvider

getRealmRolesStream

Field Detail

session

protected KeycloakSession session

Constructor Detail

RoleStorageManager

public RoleStorageManager(KeycloakSession session,
                          long roleStorageProviderTimeout)

Method Detail

isStorageProviderEnabled

public static boolean isStorageProviderEnabled(RealmModel realm,
                                               String providerId)

getStorageProviderModel

public static RoleStorageProviderModel getStorageProviderModel(RealmModel realm,
                                                               String componentId)

getStorageProvider

public static RoleStorageProvider getStorageProvider(KeycloakSession session,
                                                     RealmModel realm,
                                                     String componentId)

getStorageProviders

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

getStorageProviderInstance

public static RoleStorageProvider getStorageProviderInstance(KeycloakSession session,
                                                             RoleStorageProviderModel model,
                                                             RoleStorageProviderFactory 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)

addRealmRole

public RoleModel addRealmRole(RealmModel realm,
                              String name)

Specified by:

addRealmRole in interface RoleProvider

addRealmRole

public RoleModel addRealmRole(RealmModel realm,
                              String id,
                              String name)

Specified by:

addRealmRole in interface RoleProvider

getRealmRole

public RoleModel getRealmRole(RealmModel realm,
                              String name)

Specified by:

getRealmRole in interface RoleLookupProvider

getRoleById

public RoleModel getRoleById(RealmModel realm,
                             String id)

Specified by:

getRoleById in interface RoleLookupProvider

getRealmRolesStream

public Stream<RoleModel> getRealmRolesStream(RealmModel realm,
                                             Integer first,
                                             Integer max)

Specified by:

getRealmRolesStream in interface RoleProvider

getRolesStream

public Stream<RoleModel> getRolesStream(RealmModel realm,
                                        Stream<String> ids,
                                        String search,
                                        Integer first,
                                        Integer max)

Specified by:

getRolesStream in interface RoleProvider

searchForRolesStream

public Stream<RoleModel> searchForRolesStream(RealmModel realm,
                                              String search,
                                              Integer first,
                                              Integer max)

Obtaining roles from an external role storage is time-bounded. In case the external role storage isn't available at least roles from a local storage are returned. For this purpose the org.keycloak.services.DefaultKeycloakSessionFactory#getRoleStorageProviderTimeout() property is used. Default value is 3000 milliseconds and it's configurable. See org.keycloak.services.DefaultKeycloakSessionFactory for details.

Specified by:

searchForRolesStream in interface RoleLookupProvider

removeRole

public boolean removeRole(RoleModel role)

Specified by:

removeRole in interface RoleProvider

removeRoles

public void removeRoles(RealmModel realm)

Specified by:

removeRoles in interface RoleProvider

removeRoles

public void removeRoles(ClientModel client)

Specified by:

removeRoles in interface RoleProvider

addClientRole

public RoleModel addClientRole(ClientModel client,
                               String name)

Specified by:

addClientRole in interface RoleProvider

addClientRole

public RoleModel addClientRole(ClientModel client,
                               String id,
                               String name)

Specified by:

addClientRole in interface RoleProvider

getClientRole

public RoleModel getClientRole(ClientModel client,
                               String name)

Specified by:

getClientRole in interface RoleLookupProvider

getClientRolesStream

public Stream<RoleModel> getClientRolesStream(ClientModel client)

Specified by:

getClientRolesStream in interface RoleProvider

getClientRolesStream

public Stream<RoleModel> getClientRolesStream(ClientModel client,
                                              Integer first,
                                              Integer max)

Specified by:

getClientRolesStream in interface RoleProvider

searchForClientRolesStream

public Stream<RoleModel> searchForClientRolesStream(ClientModel client,
                                                    String search,
                                                    Integer first,
                                                    Integer max)

Obtaining roles from an external role storage is time-bounded. In case the external role storage isn't available at least roles from a local storage are returned. For this purpose the org.keycloak.services.DefaultKeycloakSessionFactory#getRoleStorageProviderTimeout()} property is used. Default value is 3000 milliseconds and it's configurable. See org.keycloak.services.DefaultKeycloakSessionFactory for details.

Specified by:

searchForClientRolesStream in interface RoleLookupProvider

close

public void close()

Specified by:

close in interface Provider