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 and Description
static interface	GroupModel.GroupRemovedEvent
static class	GroupModel.SearchableFields
static interface	GroupModel.Streams The GroupModel.Streams interface makes all collection-based methods in GroupModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<GroupModel>	COMPARE_BY_NAME

Method Summary

Modifier and Type	Method and Description
void	addChild(GroupModel subGroup) Automatically calls setParent() on the subGroup
List<String>	getAttribute(String name) Deprecated. Use getAttributeStream instead.
Map<String,List<String>>	getAttributes()
default 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()
Set<GroupModel>	getSubGroups() Deprecated. Use getSubGroupsStream instead.
default 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 subGroup
void	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 group
void	setSingleAttribute(String name, String value) Set single value of specified attribute.

Methods inherited from interface org.keycloak.models.RoleMapperModel

deleteRoleMapping, getClientRoleMappings, getClientRoleMappingsStream, getRealmRoleMappings, getRealmRoleMappingsStream, getRoleMappings, getRoleMappingsStream, grantRole, 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 -

setAttribute

void setAttribute(String name,
                  List<String> values)

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

getAttribute

@Deprecated
List<String> getAttribute(String name)

Deprecated. Use getAttributeStream instead.

Parameters:

name -

Returns:

list of all attribute values or empty list if there are not any values. Never return null

getAttributeStream

default 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.

getAttributes

Map<String,List<String>> getAttributes()

getParent

GroupModel getParent()

getParentId

String getParentId()

getSubGroups

@Deprecated
Set<GroupModel> getSubGroups()

Deprecated. Use getSubGroupsStream instead.

getSubGroupsStream

default Stream<GroupModel> getSubGroupsStream()

Returns all sub groups for the parent group as a stream.

Returns:

Stream of GroupModel. Never returns null.

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 -