org.keycloak.models.map.group

Class MapGroupAdapter<K>

java.lang.Object

org.keycloak.models.map.group.AbstractGroupModel<MapGroupEntity<K>>

org.keycloak.models.map.group.MapGroupAdapter<K>

All Implemented Interfaces:

GroupModel, GroupModel.Streams, RoleMapperModel, RoleMapperModel.Streams

public abstract class MapGroupAdapter<K>
extends AbstractGroupModel<MapGroupEntity<K>>

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.GroupModel

GroupModel.GroupRemovedEvent, GroupModel.SearchableFields, GroupModel.Streams

Field Summary

Fields inherited from class org.keycloak.models.map.group.AbstractGroupModel

entity, realm, session

Fields inherited from interface org.keycloak.models.GroupModel

COMPARE_BY_NAME

Constructor Summary

Constructors

Constructor and Description
MapGroupAdapter(KeycloakSession session, RealmModel realm, MapGroupEntity<K> entity)

Method Summary

Modifier and Type	Method and Description
void	addChild(GroupModel subGroup) Automatically calls setParent() on the subGroup
void	deleteRoleMapping(RoleModel role) Removes the given role mapping from this object.
Map<String,List<String>>	getAttributes()
Stream<String>	getAttributeStream(String name) Returns group attributes that match the given name as a stream.
Stream<RoleModel>	getClientRoleMappingsStream(ClientModel app) Returns stream of client roles that are directly set to this object for the given client.
String	getFirstAttribute(String name)
String	getName()
GroupModel	getParent()
String	getParentId()
Stream<RoleModel>	getRealmRoleMappingsStream() Returns stream of realm roles that are directly set to this object.
Stream<RoleModel>	getRoleMappingsStream() Returns stream of all role (both realm all client) that are directly set to this object.
Stream<GroupModel>	getSubGroupsStream() Returns all sub groups for the parent group as a stream.
void	grantRole(RoleModel role) Grants the given role to this object.
boolean	hasRole(RoleModel role) Returns true if this object is directly or indirectly assigned the given role, false otherwise.
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 class org.keycloak.models.map.group.AbstractGroupModel

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.GroupModel.Streams

getAttribute, getSubGroups

Methods inherited from interface org.keycloak.models.GroupModel

getId

Methods inherited from interface org.keycloak.models.RoleMapperModel.Streams

getClientRoleMappings, getRealmRoleMappings, getRoleMappings

Constructor Detail

MapGroupAdapter

public MapGroupAdapter(KeycloakSession session,
                       RealmModel realm,
                       MapGroupEntity<K> entity)

Method Detail

getName

public String getName()

setName

public void setName(String name)

setSingleAttribute

public void setSingleAttribute(String name,
                               String value)

Description copied from interface: GroupModel

Set single value of specified attribute. Remove all other existing values

setAttribute

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

removeAttribute

public void removeAttribute(String name)

getFirstAttribute

public String getFirstAttribute(String 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

public Stream<String> getAttributeStream(String name)

Description copied from interface: GroupModel

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

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

getParent

public GroupModel getParent()

getParentId

public String getParentId()

getSubGroupsStream

public Stream<GroupModel> getSubGroupsStream()

Description copied from interface: GroupModel

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

Returns:

Stream of GroupModel. Never returns null.

setParent

public void setParent(GroupModel group)

Description copied from interface: GroupModel

You must also call addChild on the parent group, addChild on RealmModel if there is no parent group

addChild

public void addChild(GroupModel subGroup)

Description copied from interface: GroupModel

Automatically calls setParent() on the subGroup

removeChild

public void removeChild(GroupModel subGroup)

Description copied from interface: GroupModel

Automatically calls setParent() on the subGroup

getRealmRoleMappingsStream

public Stream<RoleModel> getRealmRoleMappingsStream()

Description copied from interface: RoleMapperModel

Returns stream of realm roles that are directly set to this object.

Returns:

Stream of RoleModel. Never returns null.

getClientRoleMappingsStream

public Stream<RoleModel> getClientRoleMappingsStream(ClientModel app)

Description copied from interface: RoleMapperModel

Returns stream of client roles that are directly set to this object for the given client.

Parameters:

app - ClientModel Client to get the roles for.

Returns:

Stream of RoleModel. Never returns null.

hasRole

public boolean hasRole(RoleModel role)

Description copied from interface: RoleMapperModel

Returns true if this object is directly or indirectly assigned the given role, false otherwise.

For example, true is returned for hasRole(R) if:

• R is directly assigned to this object
• R is not assigned to this object but this object belongs to a group G which is assigned the role R
• R is not assigned to this object but this object belongs to a group G, and G belongs to group H which is assigned the role R

Returns:

see description

grantRole

public void grantRole(RoleModel role)

Description copied from interface: RoleMapperModel

Grants the given role to this object.

getRoleMappingsStream

public Stream<RoleModel> getRoleMappingsStream()

Description copied from interface: RoleMapperModel

Returns stream of all role (both realm all client) that are directly set to this object.

Returns:

Stream of RoleModel. Never returns null.

deleteRoleMapping

public void deleteRoleMapping(RoleModel role)

Description copied from interface: RoleMapperModel

Removes the given role mapping from this object.

Parameters:

role - Role to remove