Package org.keycloak.storage

Class GroupStorageManager

java.lang.Object

org.keycloak.storage.AbstractStorageManager<GroupStorageProvider,GroupStorageProviderModel>

org.keycloak.storage.GroupStorageManager

All Implemented Interfaces:

GroupProvider, Provider, GroupLookupProvider

public class GroupStorageManager
extends AbstractStorageManager<GroupStorageProvider,GroupStorageProviderModel>
implements GroupProvider

Field Summary

Fields inherited from class org.keycloak.storage.AbstractStorageManager

session

Constructor Summary

Constructors

Constructor	Description
GroupStorageManager(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	addTopLevelGroup(RealmModel realm, GroupModel subGroup)
void	close()
GroupModel	createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupModel	getGroupById(RealmModel realm, String id)
GroupModel	getGroupByName(RealmModel realm, GroupModel parent, String name)
Stream<GroupModel>	getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Long	getGroupsCount(RealmModel realm, Boolean onlyTopGroups)
Long	getGroupsCountByNameContaining(RealmModel realm, String search)
Stream<GroupModel>	getGroupsStream(RealmModel realm)
Stream<GroupModel>	getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<GroupModel>	getTopLevelGroupsStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)
void	moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
boolean	removeGroup(RealmModel realm, GroupModel group)
Stream<GroupModel>	searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)	Obtaining groups from an external client storage is time-bounded.
Stream<GroupModel>	searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)

Methods inherited from class org.keycloak.storage.AbstractStorageManager

consumeEnabledStorageProvidersWithTimeout, flatMapEnabledStorageProvidersWithTimeout, getEnabledStorageProviders, getStorageProviderFactory, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderModel, getStorageProviderModels, getStorageProviderTimeout, mapEnabledStorageProvidersWithTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.storage.group.GroupLookupProvider

searchForGroupByNameStream

Methods inherited from interface org.keycloak.models.GroupProvider

createGroup, createGroup, createGroup, getGroupsCount, getGroupsStream, getGroupsStream, getTopLevelGroupsStream, getTopLevelGroupsStream

Constructor Details

GroupStorageManager

public GroupStorageManager(KeycloakSession session)

Method Details

getGroupById

public GroupModel getGroupById(RealmModel realm,
 String id)

Specified by:

getGroupById in interface GroupLookupProvider

getGroupByName

public GroupModel getGroupByName(RealmModel realm,
 GroupModel parent,
 String name)

Specified by:

getGroupByName in interface GroupLookupProvider

searchGroupsByAttributes

public Stream<GroupModel> searchGroupsByAttributes(RealmModel realm,
 Map<String,String> attributes,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchGroupsByAttributes in interface GroupLookupProvider

searchForGroupByNameStream

public Stream<GroupModel> searchForGroupByNameStream(RealmModel realm,
 String search,
 Boolean exact,
 Integer firstResult,
 Integer maxResults)

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

Specified by:

searchForGroupByNameStream in interface GroupLookupProvider

getGroupsStream

public Stream<GroupModel> getGroupsStream(RealmModel realm)

Specified by:

getGroupsStream in interface GroupProvider

getGroupsStream

public Stream<GroupModel> getGroupsStream(RealmModel realm,
 Stream<String> ids,
 String search,
 Integer first,
 Integer max)

Specified by:

getGroupsStream in interface GroupProvider

getGroupsCount

public Long getGroupsCount(RealmModel realm,
 Boolean onlyTopGroups)

Specified by:

getGroupsCount in interface GroupProvider

getGroupsCountByNameContaining

public Long getGroupsCountByNameContaining(RealmModel realm,
 String search)

Specified by:

getGroupsCountByNameContaining in interface GroupProvider

getGroupsByRoleStream

public Stream<GroupModel> getGroupsByRoleStream(RealmModel realm,
 RoleModel role,
 Integer firstResult,
 Integer maxResults)

Specified by:

getGroupsByRoleStream in interface GroupProvider

getTopLevelGroupsStream

public Stream<GroupModel> getTopLevelGroupsStream(RealmModel realm,
 String search,
 Boolean exact,
 Integer firstResult,
 Integer maxResults)

Specified by:

getTopLevelGroupsStream in interface GroupProvider

createGroup

public GroupModel createGroup(RealmModel realm,
 String id,
 String name,
 GroupModel toParent)

Specified by:

createGroup in interface GroupProvider

removeGroup

public boolean removeGroup(RealmModel realm,
 GroupModel group)

Specified by:

removeGroup in interface GroupProvider

moveGroup

public void moveGroup(RealmModel realm,
 GroupModel group,
 GroupModel toParent)

Specified by:

moveGroup in interface GroupProvider

addTopLevelGroup

public void addTopLevelGroup(RealmModel realm,
 GroupModel subGroup)

Specified by:

addTopLevelGroup in interface GroupProvider

close

public void close()

Specified by:

close in interface Provider