public interface GroupProvider extends Provider, GroupLookupProvider
Modifier and Type | Method and Description |
---|---|
void |
addTopLevelGroup(RealmModel realm,
GroupModel subGroup)
Removes parent group for the given group in the given realm.
|
default GroupModel |
createGroup(RealmModel realm,
String name)
Creates a new group with the given name in the given realm.
|
default GroupModel |
createGroup(RealmModel realm,
String name,
GroupModel toParent)
Creates a new group with the given name and parent to the given realm.
|
default GroupModel |
createGroup(RealmModel realm,
String id,
String name)
Creates a new group with the given id and name in the given realm.
|
GroupModel |
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.
|
default GroupModel |
getGroupById(String id,
RealmModel realm)
Deprecated.
Use method
getGroupById |
default List<GroupModel> |
getGroups(RealmModel realm)
Deprecated.
Use
getGroupsStream instead. |
default List<GroupModel> |
getGroupsByRole(RealmModel realm,
RoleModel role,
int firstResult,
int maxResults)
Deprecated.
Use
getGroupsByRoleStream instead. |
Stream<GroupModel> |
getGroupsByRoleStream(RealmModel realm,
RoleModel role,
Integer firstResult,
Integer maxResults)
Returns groups with the given role in the given realm.
|
Long |
getGroupsCount(RealmModel realm,
Boolean onlyTopGroups)
Returns a number of groups/top level groups (i.e.
|
default Long |
getGroupsCount(RealmModel realm,
Stream<String> ids,
String search)
Returns a number of groups that contains the search string in the name
|
Long |
getGroupsCountByNameContaining(RealmModel realm,
String search)
Returns number of groups with the given string in name for the given realm.
|
Stream<GroupModel> |
getGroupsStream(RealmModel realm)
Returns groups for the given realm.
|
default Stream<GroupModel> |
getGroupsStream(RealmModel realm,
Stream<String> ids)
Returns a stream of groups with given ids.
|
default Stream<GroupModel> |
getGroupsStream(RealmModel realm,
Stream<String> ids,
Integer first,
Integer max)
Returns a paginated stream of groups with given ids.
|
Stream<GroupModel> |
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.
|
default List<GroupModel> |
getTopLevelGroups(RealmModel realm)
Deprecated.
Use
getTopLevelGroupsStream instead. |
default List<GroupModel> |
getTopLevelGroups(RealmModel realm,
Integer firstResult,
Integer maxResults)
Deprecated.
Use
getTopLevelGroupsStream instead. |
Stream<GroupModel> |
getTopLevelGroupsStream(RealmModel realm)
Returns all top level groups (i.e.
|
Stream<GroupModel> |
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.
|
getGroupById, searchForGroupByName, searchForGroupByNameStream
default GroupModel getGroupById(String id, RealmModel realm)
getGroupById
id
- Id.realm
- Realm.@Deprecated default List<GroupModel> getGroups(RealmModel realm)
getGroupsStream
instead.realm
- Realm.Stream<GroupModel> getGroupsStream(RealmModel realm)
realm
- Realm.default Stream<GroupModel> getGroupsStream(RealmModel realm, Stream<String> ids)
getGroupsStream(realm, ids, null, null, null)
.realm
- Realm.ids
- Stream of ids.Stream<GroupModel> getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
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 or null
.max
- Maximum number of results to return. Ignored if negative or null
.null
.default Stream<GroupModel> getGroupsStream(RealmModel realm, Stream<String> ids, Integer first, Integer max)
getGroupsStream(realm, ids, null, first, max)
.realm
- Realm.ids
- Stream of ids.first
- Index of the first result to return. Ignored if negative or null
.max
- Maximum number of results to return. Ignored if negative or null
.default Long getGroupsCount(RealmModel realm, Stream<String> ids, String search)
realm
- Realm.ids
- List of ids.search
- Case insensitive string which will be searched for. Ignored if null.Long getGroupsCount(RealmModel realm, Boolean onlyTopGroups)
realm
- Realm.onlyTopGroups
- When true the function returns a count of top level groups only.Long getGroupsCountByNameContaining(RealmModel realm, String search)
realm
- Realm.search
- Case insensitive string which will be searched for.@Deprecated default List<GroupModel> getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)
getGroupsByRoleStream
instead.realm
- Realm.role
- Role.firstResult
- First result to return. Ignored if negative or null
.maxResults
- Maximum number of results to return. Ignored if negative or null
.Stream<GroupModel> getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
realm
- Realm.role
- Role.firstResult
- First result to return. Ignored if negative or null
.maxResults
- Maximum number of results to return. Ignored if negative or null
.null
.@Deprecated default List<GroupModel> getTopLevelGroups(RealmModel realm)
getTopLevelGroupsStream
instead.realm
- Realm.Stream<GroupModel> getTopLevelGroupsStream(RealmModel realm)
realm
- Realm.null
.@Deprecated default List<GroupModel> getTopLevelGroups(RealmModel realm, Integer firstResult, Integer maxResults)
getTopLevelGroupsStream
instead.realm
- Realm.firstResult
- First result to return. Ignored if negative or null
.maxResults
- Maximum number of results to return. Ignored if negative or null
.Stream<GroupModel> getTopLevelGroupsStream(RealmModel realm, Integer firstResult, Integer maxResults)
realm
- Realm.firstResult
- First result to return. Ignored if negative or null
.maxResults
- Maximum number of results to return. Ignored if negative or null
.null
.default GroupModel createGroup(RealmModel realm, String name)
createGroup(realm, null, name, null)
.realm
- Realm.name
- Name.ModelDuplicateException
- If there is already a top-level group with the given namedefault GroupModel createGroup(RealmModel realm, String id, String name)
createGroup(realm, id, name, null)
realm
- Realm.id
- Id.name
- Name.ModelDuplicateException
- If a group with given id already exists or there is a top-level group with the given namedefault GroupModel createGroup(RealmModel realm, String name, GroupModel toParent)
createGroup(realm, null, name, toParent)
.realm
- Realm.name
- Name.toParent
- Parent group.ModelDuplicateException
- If the toParent group already has a subgroup with the given nameGroupModel createGroup(RealmModel realm, String id, String name, GroupModel toParent)
realm
- Realm.id
- Id, will be generated if null
.name
- Name.toParent
- Parent group, or null
if the group is top level groupModelDuplicateException
- If a group with the given id already exists or the toParent group has a subgroup with the given nameboolean removeGroup(RealmModel realm, GroupModel group)
realm
- Realm.group
- Group.void moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
realm
- Realm owning this group.group
- Group to update.toParent
- New parent group, or null
if we are moving the group to top level group.ModelDuplicateException
- If there is already a group with group.name under the toParent group (or top-level if toParent is null)void addTopLevelGroup(RealmModel realm, GroupModel subGroup)
realm
- Realm.subGroup
- Group.ModelDuplicateException
- If there is already a top level group name with the same nameCopyright © 2021 JBoss by Red Hat. All rights reserved.