Package org.keycloak.models.jpa

Class GroupAdapter

java.lang.Object

org.keycloak.models.jpa.GroupAdapter

All Implemented Interfaces:

GroupModel, JpaModel<GroupEntity>, RoleMapperModel

public class GroupAdapter
extends Object
implements GroupModel, JpaModel<GroupEntity>

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

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

GroupModel.GroupCreatedEvent, GroupModel.GroupEvent, GroupModel.GroupMemberJoinEvent, GroupModel.GroupMemberLeaveEvent, GroupModel.GroupPathChangeEvent, GroupModel.GroupRemovedEvent, GroupModel.GroupUpdatedEvent, GroupModel.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.persistence.EntityManager	em
protected GroupEntity	group
protected RealmModel	realm
protected final KeycloakSession	session

Fields inherited from interface org.keycloak.models.GroupModel

COMPARE_BY_NAME

Constructor Summary

Constructors

Constructor	Description
GroupAdapter(KeycloakSession session, RealmModel realm, jakarta.persistence.EntityManager em, GroupEntity group)

Method Summary

Modifier and Type	Method	Description
void	addChild(GroupModel subGroup)	Automatically calls setParent() on the subGroup
void	deleteRoleMapping(RoleModel role)	Removes the given role mapping from this object.
boolean	equals(Object o)
boolean	escapeSlashesInGroupPath()
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	getDescription()
GroupEntity	getEntity()
String	getFirstAttribute(String name)
protected jakarta.persistence.TypedQuery<GroupRoleMappingEntity>	getGroupRoleMappingEntityTypedQuery(RoleModel role)
String	getId()
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.
Long	getSubGroupsCount()	Returns the number of groups contained beneath this group.
Stream<GroupModel>	getSubGroupsStream()	Returns all sub groups for the parent group as a stream.
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.
GroupModel.Type	getType()
void	grantRole(RoleModel role)	Grants the given role to this object.
int	hashCode()
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	setDescription(String description)
void	setName(String name)
void	setParent(GroupModel parent)	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.
static GroupEntity	toEntity(GroupModel model, jakarta.persistence.EntityManager em)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.GroupModel

getSubGroupsStream, getSubGroupsStream

Methods inherited from interface org.keycloak.models.RoleMapperModel

hasDirectRole

Field Details

session

protected final KeycloakSession session

group

protected GroupEntity group

em

protected jakarta.persistence.EntityManager em

realm

protected RealmModel realm

Constructor Details

GroupAdapter

public GroupAdapter(KeycloakSession session,
 RealmModel realm,
 jakarta.persistence.EntityManager em,
 GroupEntity group)

Method Details

getEntity

public GroupEntity getEntity()

Specified by:

getEntity in interface JpaModel<GroupEntity>

getId

public String getId()

Specified by:

getId in interface GroupModel

getName

public String getName()

Specified by:

getName in interface GroupModel

setName

public void setName(String name)

Specified by:

setName in interface GroupModel

getDescription

public String getDescription()

Specified by:

getDescription in interface GroupModel

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface GroupModel

getParent

public GroupModel getParent()

Specified by:

getParent in interface GroupModel

getParentId

public String getParentId()

Specified by:

getParentId in interface GroupModel

toEntity

public static GroupEntity toEntity(GroupModel model,
 jakarta.persistence.EntityManager em)

setParent

public void setParent(GroupModel parent)

Description copied from interface: GroupModel

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

Specified by:

setParent in interface GroupModel

addChild

public void addChild(GroupModel subGroup)

Description copied from interface: GroupModel

Automatically calls setParent() on the subGroup

Specified by:

addChild in interface GroupModel

removeChild

public void removeChild(GroupModel subGroup)

Description copied from interface: GroupModel

Automatically calls setParent() on the subGroup

Specified by:

removeChild in interface GroupModel

getSubGroupsStream

public Stream<GroupModel> getSubGroupsStream()

Description copied from interface: GroupModel

Returns all sub groups for the parent group as a stream. The stream is sorted by the group name.

Specified by:

getSubGroupsStream in interface GroupModel

Returns:

Stream of GroupModel. Never returns null.

getSubGroupsStream

public Stream<GroupModel> getSubGroupsStream(String search,
 Boolean exact,
 Integer firstResult,
 Integer maxResults)

Description copied from interface: GroupModel

Returns all subgroups for the parent group matching the search as a stream, paginated. Stream is sorted by the group name.

Specified by:

getSubGroupsStream in interface GroupModel

Parameters:

search - search string. If empty or null all subgroups are returned.

exact - toggles fuzzy searching

firstResult - First result to return. Ignored if negative or null.

maxResults - Maximum number of results to return. Ignored if negative or null.

Returns:

Stream of GroupModel. Never returns null.

getSubGroupsCount

public Long getSubGroupsCount()

Description copied from interface: GroupModel

Returns the number of groups contained beneath this group.

Specified by:

getSubGroupsCount in interface GroupModel

Returns:

The number of groups beneath this group. Never returns null.

setSingleAttribute

public void setSingleAttribute(String name,
 String value)

Description copied from interface: GroupModel

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

Specified by:

setSingleAttribute in interface GroupModel

setAttribute

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

Specified by:

setAttribute in interface GroupModel

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface GroupModel

getFirstAttribute

public String getFirstAttribute(String name)

Specified by:

getFirstAttribute in interface GroupModel

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.

Specified by:

getAttributeStream in interface GroupModel

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()

Specified by:

getAttributes in interface GroupModel

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 indirectly assigned to this object via composites
• 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

Specified by:

hasRole in interface RoleMapperModel

Returns:

see description

See Also:

• if you want to check if this object is directly assigned to a role

getGroupRoleMappingEntityTypedQuery

protected jakarta.persistence.TypedQuery<GroupRoleMappingEntity> getGroupRoleMappingEntityTypedQuery(RoleModel role)

grantRole

public void grantRole(RoleModel role)

Description copied from interface: RoleMapperModel

Grants the given role to this object.

Specified by:

grantRole in interface RoleMapperModel

getRealmRoleMappingsStream

public Stream<RoleModel> getRealmRoleMappingsStream()

Description copied from interface: RoleMapperModel

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

Specified by:

getRealmRoleMappingsStream in interface RoleMapperModel

Returns:

Stream of RoleModel. Never returns null.

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.

Specified by:

getRoleMappingsStream in interface RoleMapperModel

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.

Specified by:

deleteRoleMapping in interface RoleMapperModel

Parameters:

role - Role to remove

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.

Specified by:

getClientRoleMappingsStream in interface RoleMapperModel

Parameters:

app - ClientModel Client to get the roles for.

Returns:

Stream of RoleModel. Never returns null.

getType

public GroupModel.Type getType()

Specified by:

getType in interface GroupModel

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

escapeSlashesInGroupPath

public boolean escapeSlashesInGroupPath()

Specified by:

escapeSlashesInGroupPath in interface GroupModel