org.keycloak.models

Interface RoleMapperModel

All Known Subinterfaces:

CachedUserModel, GroupModel, UserModel

All Known Implementing Classes:

AbstractUserAdapter, AbstractUserAdapterFederatedStorage, UserModelDelegate

public interface RoleMapperModel

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

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

Method Detail

getRealmRoleMappings

Set<RoleModel> getRealmRoleMappings()

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

Returns:

see description

getClientRoleMappings

Set<RoleModel> getClientRoleMappings(ClientModel app)

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

Parameters:

app - Client to get the roles for

Returns:

see description

hasRole

boolean hasRole(RoleModel role)

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

Parameters:

role -

Returns:

see description

grantRole

void grantRole(RoleModel role)

Grants the given role to this object.

Parameters:

role -

getRoleMappings

Set<RoleModel> getRoleMappings()

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

Returns:

deleteRoleMapping

void deleteRoleMapping(RoleModel role)

Removes the given role mapping from this object.

Parameters:

role - Role to remove