Package org.keycloak.models.map.realm

Class MapRealmProvider

java.lang.Object

org.keycloak.models.map.realm.MapRealmProvider

All Implemented Interfaces:

RealmProvider, Provider

public class MapRealmProvider
extends Object
implements RealmProvider

Constructor Summary

Constructors

Constructor	Description
MapRealmProvider(KeycloakSession session, MapStorage<MapRealmEntity,RealmModel> realmStore)

Method Summary

Modifier and Type	Method	Description
void	close()
RealmModel	createRealm(String name)	Creates new realm with the given name.
RealmModel	createRealm(String id, String name)	Created new realm with given ID and name.
boolean	deleteLocalizationText(RealmModel realm, String locale, String key)
boolean	deleteLocalizationTextsByLocale(RealmModel realm, String locale)
String	getLocalizationTextsById(RealmModel realm, String locale, String key)
RealmModel	getRealm(String id)	Exact search for a realm by its internal ID.
RealmModel	getRealmByName(String name)	Exact search for a realm by its name.
Stream<RealmModel>	getRealmsStream()	Returns realms as a stream.
Stream<RealmModel>	getRealmsWithProviderTypeStream(Class<?> type)	Returns stream of realms which has component with the given provider type.
void	removeExpiredClientInitialAccess()	Removes all expired client initial accesses from all realms.
boolean	removeRealm(String id)	Removes realm with the given id.
void	saveLocalizationText(RealmModel realm, String locale, String key, String text)
void	saveLocalizationTexts(RealmModel realm, String locale, Map<String,String> localizationTexts)
boolean	updateLocalizationText(RealmModel realm, String locale, String key, String text)

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

createClientInitialAccessModel, decreaseRemainingCount, getClientInitialAccessModel, listClientInitialAccessStream, removeClientInitialAccessModel

Constructor Details

MapRealmProvider

public MapRealmProvider(KeycloakSession session,
 MapStorage<MapRealmEntity,RealmModel> realmStore)

Method Details

createRealm

public RealmModel createRealm(String name)

Description copied from interface: RealmProvider

Creates new realm with the given name. The internal ID will be generated automatically.

Specified by:

createRealm in interface RealmProvider

Parameters:

name - String name of the realm

Returns:

Model of the created realm.

createRealm

public RealmModel createRealm(String id,
 String name)

Description copied from interface: RealmProvider

Created new realm with given ID and name.

Specified by:

createRealm in interface RealmProvider

Parameters:

id - Internal ID of the realm or null if one is to be created by the underlying store. If the store expects the ID to have a certain format (for example UUID) and the supplied ID doesn't follow the expected format, the store may replace the id with a new one at its own discretion.

name - String name of the realm

Returns:

Model of the created realm.

getRealm

public RealmModel getRealm(String id)

Description copied from interface: RealmProvider

Exact search for a realm by its internal ID.

Specified by:

getRealm in interface RealmProvider

Parameters:

id - Internal ID of the realm.

Returns:

Model of the realm

getRealmByName

public RealmModel getRealmByName(String name)

Description copied from interface: RealmProvider

Exact search for a realm by its name.

Specified by:

getRealmByName in interface RealmProvider

Parameters:

name - String name of the realm

Returns:

Model of the realm

getRealmsStream

public Stream<RealmModel> getRealmsStream()

Description copied from interface: RealmProvider

Returns realms as a stream.

Specified by:

getRealmsStream in interface RealmProvider

Returns:

Stream of RealmModel. Never returns null.

getRealmsWithProviderTypeStream

public Stream<RealmModel> getRealmsWithProviderTypeStream(Class<?> type)

Description copied from interface: RealmProvider

Returns stream of realms which has component with the given provider type.

Specified by:

getRealmsWithProviderTypeStream in interface RealmProvider

Parameters:

type - Class<?> Type of the provider.

Returns:

Stream of RealmModel. Never returns null.

removeRealm

public boolean removeRealm(String id)

Description copied from interface: RealmProvider

Removes realm with the given id.

Specified by:

removeRealm in interface RealmProvider

Parameters:

id - of realm.

Returns:

true if the realm was successfully removed.

removeExpiredClientInitialAccess

public void removeExpiredClientInitialAccess()

Description copied from interface: RealmProvider

Removes all expired client initial accesses from all realms.

Specified by:

removeExpiredClientInitialAccess in interface RealmProvider

saveLocalizationText

public void saveLocalizationText(RealmModel realm,
 String locale,
 String key,
 String text)

Specified by:

saveLocalizationText in interface RealmProvider

saveLocalizationTexts

public void saveLocalizationTexts(RealmModel realm,
 String locale,
 Map<String,String> localizationTexts)

Specified by:

saveLocalizationTexts in interface RealmProvider

updateLocalizationText

public boolean updateLocalizationText(RealmModel realm,
 String locale,
 String key,
 String text)

Specified by:

updateLocalizationText in interface RealmProvider

deleteLocalizationTextsByLocale

public boolean deleteLocalizationTextsByLocale(RealmModel realm,
 String locale)

Specified by:

deleteLocalizationTextsByLocale in interface RealmProvider

deleteLocalizationText

public boolean deleteLocalizationText(RealmModel realm,
 String locale,
 String key)

Specified by:

deleteLocalizationText in interface RealmProvider

getLocalizationTextsById

public String getLocalizationTextsById(RealmModel realm,
 String locale,
 String key)

Specified by:

getLocalizationTextsById in interface RealmProvider

close

public void close()

Specified by:

close in interface Provider