Package org.keycloak.models
Interface GroupModel
- All Superinterfaces:
RoleMapperModel
- All Known Implementing Classes:
GroupAdapter
,GroupAdapter
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
static interface
static interface
static interface
static interface
static interface
static interface
static enum
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addChild
(GroupModel subGroup) Automatically calls setParent() on the subGroupdefault boolean
getAttributeStream
(String name) Returns group attributes that match the given name as a stream.getFirstAttribute
(String name) getId()
getName()
default Long
Returns the number of groups contained beneath this group.Returns all sub groups for the parent group as a stream.default Stream<GroupModel>
getSubGroupsStream
(Integer firstResult, Integer maxResults) Returns all sub groups for the parent group as a stream, paginated.default Stream<GroupModel>
getSubGroupsStream
(String search, Boolean exact, Integer firstResult, Integer maxResults) Returns all subgroups for the parent group matching the search as a stream, paginated.default Stream<GroupModel>
getSubGroupsStream
(String search, Integer firstResult, Integer maxResults) Returns all sub groups for the parent group matching the fuzzy search as a stream, paginated.default GroupModel.Type
getType()
void
removeAttribute
(String name) void
removeChild
(GroupModel subGroup) Automatically calls setParent() on the subGroupvoid
setAttribute
(String name, List<String> values) void
void
setParent
(GroupModel group) You must also call addChild on the parent group, addChild on RealmModel if there is no parent groupvoid
setSingleAttribute
(String name, String value) Set single value of specified attribute.Methods inherited from interface org.keycloak.models.RoleMapperModel
deleteRoleMapping, getClientRoleMappingsStream, getRealmRoleMappingsStream, getRoleMappingsStream, grantRole, hasDirectRole, hasRole
-
Field Details
-
COMPARE_BY_NAME
-
-
Method Details
-
getId
String getId() -
getName
String getName() -
setName
-
setSingleAttribute
Set single value of specified attribute. Remove all other existing values- Parameters:
name
-value
-
-
setAttribute
-
removeAttribute
-
getFirstAttribute
- Parameters:
name
-- Returns:
- null if there is not any value of specified attribute or first value otherwise. Don't throw exception if there are more values of the attribute
-
getAttributeStream
Returns group attributes that match the given name as a stream.- Parameters:
name
-String
Name of the attribute to be used as a filter.- Returns:
- Stream of all attribute values or empty stream if there are not any values. Never return
null
.
-
getAttributes
-
getParent
GroupModel getParent() -
getParentId
String getParentId() -
getSubGroupsStream
Stream<GroupModel> getSubGroupsStream()Returns all sub groups for the parent group as a stream. The stream is sorted by the group name.- Returns:
- Stream of
GroupModel
. Never returnsnull
.
-
getSubGroupsStream
default Stream<GroupModel> getSubGroupsStream(String search, Integer firstResult, Integer maxResults) Returns all sub groups for the parent group matching the fuzzy search as a stream, paginated. Stream is sorted by the group name.- Parameters:
search
- searched string. If empty ornull
all subgroups are returned.- Returns:
- Stream of
GroupModel
. Never returnsnull
.
-
getSubGroupsStream
Returns all sub groups for the parent group as a stream, paginated.- Parameters:
firstResult
- First result to return. Ignored if negative ornull
.maxResults
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
-
getSubGroupsStream
default Stream<GroupModel> getSubGroupsStream(String search, Boolean exact, Integer firstResult, Integer maxResults) Returns all subgroups for the parent group matching the search as a stream, paginated. Stream is sorted by the group name.- Parameters:
search
- search string. If empty ornull
all subgroups are returned.exact
- toggles fuzzy searchingfirstResult
- First result to return. Ignored if negative ornull
.maxResults
- Maximum number of results to return. Ignored if negative ornull
.- Returns:
- Stream of
GroupModel
. Never returnsnull
.
-
getSubGroupsCount
Returns the number of groups contained beneath this group.- Returns:
- The number of groups beneath this group. Never returns
null
.
-
setParent
You must also call addChild on the parent group, addChild on RealmModel if there is no parent group- Parameters:
group
-
-
addChild
Automatically calls setParent() on the subGroup- Parameters:
subGroup
-
-
removeChild
Automatically calls setParent() on the subGroup- Parameters:
subGroup
-
-
escapeSlashesInGroupPath
default boolean escapeSlashesInGroupPath() -
getType
-