Package org.keycloak.models
Interface GroupModel
-
- All Superinterfaces:
RoleMapperModel
- All Known Subinterfaces:
GroupModel.Streams
- All Known Implementing Classes:
AbstractGroupModel
,GroupAdapter
,GroupAdapter
,MapGroupAdapter
public interface GroupModel extends RoleMapperModel
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
GroupModel.GroupPathChangeEvent
static interface
GroupModel.GroupRemovedEvent
static class
GroupModel.SearchableFields
static interface
GroupModel.Streams
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
-
Field Summary
Fields Modifier and Type Field Description static Comparator<GroupModel>
COMPARE_BY_NAME
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addChild(GroupModel subGroup)
Automatically calls setParent() on the subGroupMap<String,List<String>>
getAttributes()
Stream<String>
getAttributeStream(String name)
Returns group attributes that match the given name as a stream.String
getFirstAttribute(String name)
String
getId()
String
getName()
GroupModel
getParent()
String
getParentId()
Stream<GroupModel>
getSubGroupsStream()
Returns all sub groups for the parent group as a stream.void
removeAttribute(String name)
void
removeChild(GroupModel subGroup)
Automatically calls setParent() on the subGroupvoid
setAttribute(String name, List<String> values)
void
setName(String name)
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 Detail
-
COMPARE_BY_NAME
static final Comparator<GroupModel> COMPARE_BY_NAME
-
-
Method Detail
-
getId
String getId()
-
getName
String getName()
-
setName
void setName(String name)
-
setSingleAttribute
void setSingleAttribute(String name, String value)
Set single value of specified attribute. Remove all other existing values- Parameters:
name
-value
-
-
removeAttribute
void removeAttribute(String name)
-
getFirstAttribute
String getFirstAttribute(String name)
- 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
Stream<String> getAttributeStream(String name)
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
.
-
getParent
GroupModel getParent()
-
getParentId
String getParentId()
-
getSubGroupsStream
Stream<GroupModel> getSubGroupsStream()
Returns all sub groups for the parent group as a stream.- Returns:
- Stream of
GroupModel
. Never returnsnull
.
-
setParent
void setParent(GroupModel group)
You must also call addChild on the parent group, addChild on RealmModel if there is no parent group- Parameters:
group
-
-
addChild
void addChild(GroupModel subGroup)
Automatically calls setParent() on the subGroup- Parameters:
subGroup
-
-
removeChild
void removeChild(GroupModel subGroup)
Automatically calls setParent() on the subGroup- Parameters:
subGroup
-
-
-