org.keycloak.storage.ldap.mappers.membership.role

Class RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate

java.lang.Object

org.keycloak.models.utils.UserModelDelegate

org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate

All Implemented Interfaces:

RoleMapperModel, UserModel

Enclosing class:

RoleLDAPStorageMapper

public class RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate
extends UserModelDelegate

Nested Class Summary

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

UserModel.RequiredAction, UserModel.UserRemovedEvent

Field Summary

Fields inherited from class org.keycloak.models.utils.UserModelDelegate

delegate

Fields inherited from interface org.keycloak.models.UserModel

EMAIL, FIRST_NAME, GROUPS, INCLUDE_SERVICE_ACCOUNT, LAST_NAME, LOCALE, SEARCH, USERNAME

Constructor Summary

Constructors

Constructor and Description
LDAPRoleMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser)

Method Summary

Modifier and Type	Method and Description
void	deleteRoleMapping(RoleModel role) Removes the given role mapping from this object.
Set<RoleModel>	getClientRoleMappings(ClientModel client) Returns set of client roles that are directly set to this object for the given client.
protected Set<RoleModel>	getLDAPRoleMappingsConverted()
Set<RoleModel>	getRealmRoleMappings() Returns set of realm roles that are directly set to this object.
Set<RoleModel>	getRoleMappings() Returns set of all role (both realm all client) that are directly set to this object.
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.

Methods inherited from class org.keycloak.models.utils.UserModelDelegate

addRequiredAction, addRequiredAction, equals, getAttribute, getAttributes, getCreatedTimestamp, getDelegate, getEmail, getFederationLink, getFirstAttribute, getFirstName, getGroups, getId, getLastName, getRequiredActions, getServiceAccountClientLink, getUsername, hashCode, isEmailVerified, isEnabled, isMemberOf, joinGroup, leaveGroup, removeAttribute, removeRequiredAction, removeRequiredAction, setAttribute, setCreatedTimestamp, setEmail, setEmailVerified, setEnabled, setFederationLink, setFirstName, setLastName, setServiceAccountClientLink, setSingleAttribute, setUsername

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.UserModel

getGroups, getGroups, getGroupsCount, getGroupsCountByNameContaining

Constructor Detail

LDAPRoleMappingsUserDelegate

public LDAPRoleMappingsUserDelegate(RealmModel realm,
                                    UserModel user,
                                    LDAPObject ldapUser)

Method Detail

getRealmRoleMappings

public Set<RoleModel> getRealmRoleMappings()

Description copied from interface: RoleMapperModel

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

Specified by:

getRealmRoleMappings in interface RoleMapperModel

Overrides:

getRealmRoleMappings in class UserModelDelegate

Returns:

see description

getClientRoleMappings

public Set<RoleModel> getClientRoleMappings(ClientModel client)

Description copied from interface: RoleMapperModel

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

Specified by:

getClientRoleMappings in interface RoleMapperModel

Overrides:

getClientRoleMappings in class UserModelDelegate

Parameters:

client - Client to get the roles for

Returns:

see description

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

Specified by:

hasRole in interface RoleMapperModel

Overrides:

hasRole in class UserModelDelegate

Returns:

see description

grantRole

public void grantRole(RoleModel role)

Description copied from interface: RoleMapperModel

Grants the given role to this object.

Specified by:

grantRole in interface RoleMapperModel

Overrides:

grantRole in class UserModelDelegate

getRoleMappings

public Set<RoleModel> getRoleMappings()

Description copied from interface: RoleMapperModel

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

Specified by:

getRoleMappings in interface RoleMapperModel

Overrides:

getRoleMappings in class UserModelDelegate

Returns:

getLDAPRoleMappingsConverted

protected Set<RoleModel> getLDAPRoleMappingsConverted()

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

Overrides:

deleteRoleMapping in class UserModelDelegate

Parameters:

role - Role to remove