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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addTopLevelGroup
(RealmModel realm, GroupModel subGroup) Removes parent group for the given group in the given realm.void
close()
createGroup
(RealmModel realm, String id, String name, GroupModel toParent) Creates a new group with the given name, id, name and parent to the given realm.getGroupById
(RealmModel realm, String id) Returns a group from the given realm with the corresponding idgetGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) Returns groups with the given role in the given realm.getGroupsCount
(RealmModel realm, Boolean onlyTopGroups) Returns a number of groups/top level groups (i.e.getGroupsCountByNameContaining
(RealmModel realm, String search) Returns the number of top level groups containing groups with the given string in name for the given realm.getGroupsStream
(RealmModel realm) Returns groups for the given realm.getGroupsStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) Returns a paginated stream of groups with given ids and given search value in group names.Returns all top level groups (i.e.getTopLevelGroupsStream
(RealmModel realm, Integer firstResult, Integer maxResults) Returns top level groups (i.e.void
moveGroup
(RealmModel realm, GroupModel group, GroupModel toParent) This method is used for moving groups in group structure, for example: making an existing child group child group of some other group, setting a top level group (i.e.boolean
removeGroup
(RealmModel realm, GroupModel group) Removes the given group for the given realm.searchForGroupByNameStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) Obtaining groups from an external client storage is time-bounded.searchGroupsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) Returns the groups filtered by attribute names and attribute values for the given realm.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
-
Constructor Details
-
GroupStorageManager
-
-
Method Details
-
getGroupById
Description copied from interface:GroupLookupProvider
Returns a group from the given realm with the corresponding id- Specified by:
getGroupById
in interfaceGroupLookupProvider
- Parameters:
realm
- Realm.id
- Id.- Returns:
- GroupModel with the corresponding id.
-
searchGroupsByAttributes
public Stream<GroupModel> searchGroupsByAttributes(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) Description copied from interface:GroupLookupProvider
Returns the groups filtered by attribute names and attribute values for the given realm.- Specified by:
searchGroupsByAttributes
in interfaceGroupLookupProvider
- Parameters:
realm
- Realm.attributes
- name-value pairs that are compared to group attributes.firstResult
- First result to return. Ignored if negative ornull
.maxResults
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
- Stream of groups with attributes matching all searched attributes. Never returns
null
.
-
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 theDefaultKeycloakSessionFactory.getClientStorageProviderTimeout()
property is used. Default value is 3000 milliseconds and it's configurable. SeeDefaultKeycloakSessionFactory
for details.- Specified by:
searchForGroupByNameStream
in interfaceGroupLookupProvider
- Parameters:
realm
- Realm.search
- Case sensitive searched string.exact
- Boolean which defines wheather search param should be matched exactly.firstResult
- First result to return. Ignored if negative ornull
.maxResults
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
- Stream of root groups that have the given string in their name themself or a group in their child-collection has.
The returned hierarchy contains siblings that do not necessarily have a matching name. Never returns
null
.
-
getGroupsStream
Description copied from interface:GroupProvider
Returns groups for the given realm.- Specified by:
getGroupsStream
in interfaceGroupProvider
- Parameters:
realm
- Realm.- Returns:
- Stream of groups in the Realm.
-
getGroupsStream
public Stream<GroupModel> getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) Description copied from interface:GroupProvider
Returns a paginated stream of groups with given ids and given search value in group names.- Specified by:
getGroupsStream
in interfaceGroupProvider
- Parameters:
realm
- Realm.ids
- Stream of ids.search
- Case insensitive string which will be searched for. Ignored if null.first
- Index of the first result to return. Ignored if negative ornull
.max
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
- Stream of desired groups. Never returns
null
.
-
getGroupsCount
Description copied from interface:GroupProvider
Returns a number of groups/top level groups (i.e. groups without parent group) for the given realm.- Specified by:
getGroupsCount
in interfaceGroupProvider
- Parameters:
realm
- Realm.onlyTopGroups
- When true the function returns a count of top level groups only.- Returns:
- Number of groups/top level groups.
-
getGroupsCountByNameContaining
Description copied from interface:GroupProvider
Returns the number of top level groups containing groups with the given string in name for the given realm.- Specified by:
getGroupsCountByNameContaining
in interfaceGroupProvider
- Parameters:
realm
- Realm.search
- Case insensitive string which will be searched for.- Returns:
- Number of groups with the given string in its name.
-
getGroupsByRoleStream
public Stream<GroupModel> getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) Description copied from interface:GroupProvider
Returns groups with the given role in the given realm.- Specified by:
getGroupsByRoleStream
in interfaceGroupProvider
- Parameters:
realm
- Realm.role
- Role.firstResult
- First result to return. Ignored if negative ornull
.maxResults
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
- Stream of groups with the given role. Never returns
null
.
-
getTopLevelGroupsStream
Description copied from interface:GroupProvider
Returns all top level groups (i.e. groups without parent group) for the given realm.- Specified by:
getTopLevelGroupsStream
in interfaceGroupProvider
- Parameters:
realm
- Realm.- Returns:
- Stream of all top level groups in the realm. Never returns
null
.
-
getTopLevelGroupsStream
public Stream<GroupModel> getTopLevelGroupsStream(RealmModel realm, Integer firstResult, Integer maxResults) Description copied from interface:GroupProvider
Returns top level groups (i.e. groups without parent group) for the given realm.- Specified by:
getTopLevelGroupsStream
in interfaceGroupProvider
- Parameters:
realm
- Realm.firstResult
- First result to return. Ignored if negative ornull
.maxResults
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
- Stream of top level groups in the realm. Never returns
null
.
-
createGroup
Description copied from interface:GroupProvider
Creates a new group with the given name, id, name and parent to the given realm.- Specified by:
createGroup
in interfaceGroupProvider
- Parameters:
realm
- Realm.id
- Id, will be generated ifnull
.name
- Name.toParent
- Parent group, ornull
if the group is top level group- Returns:
- Model of the created group
-
removeGroup
Description copied from interface:GroupProvider
Removes the given group for the given realm.- Specified by:
removeGroup
in interfaceGroupProvider
- Parameters:
realm
- Realm.group
- Group.- Returns:
- true if the group was removed, false if group doesn't exist or doesn't belong to the given realm
-
moveGroup
Description copied from interface:GroupProvider
This method is used for moving groups in group structure, for example:- making an existing child group child group of some other group,
- setting a top level group (i.e. group without parent group) child of some group,
- making a child group top level group (i.e. removing its parent group).
- Specified by:
moveGroup
in interfaceGroupProvider
- Parameters:
realm
- Realm owning this group.group
- Group to update.toParent
- New parent group, ornull
if we are moving the group to top level group.
-
addTopLevelGroup
Description copied from interface:GroupProvider
Removes parent group for the given group in the given realm.- Specified by:
addTopLevelGroup
in interfaceGroupProvider
- Parameters:
realm
- Realm.subGroup
- Group.
-
close
public void close()
-