## Uses of Interface
org.keycloak.models.RoleModel

- Packages that use RoleModel
  Package | Description
  --- | ---
  org.keycloak.examples.federation.properties |
  org.keycloak.exportimport.util |
  org.keycloak.federation.ldap |
  org.keycloak.login |
  org.keycloak.login.freemarker |
  org.keycloak.login.freemarker.model |
  org.keycloak.models |
  org.keycloak.models.cache |
  org.keycloak.models.cache.entities |
  org.keycloak.models.jpa |
  org.keycloak.models.mongo.keycloak.adapters |
  org.keycloak.models.utils |
  org.keycloak.services.managers |
  org.keycloak.services.resources.admin |
  org.keycloak.test.tools.jobs |
  org.keycloak.testutils |

- - ### Uses of RoleModel in org.keycloak.examples.federation.properties

    Methods in org.keycloak.examples.federation.properties with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | BasePropertiesFederationProvider.`preRemove(RealmModel realm, RoleModel role)`

  - ### Uses of RoleModel in org.keycloak.exportimport.util

    Methods in org.keycloak.exportimport.util with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `static RoleRepresentation` | ExportUtils.`exportRole(RoleModel role)` Full export of role including composite roles

    Method parameters in org.keycloak.exportimport.util with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `static List<RoleRepresentation>` | ExportUtils.`exportRoles(Collection<RoleModel> roles)`
    `static List<String>` | ExportUtils.`getRoleNames(Collection<RoleModel> roles)`

  - ### Uses of RoleModel in org.keycloak.federation.ldap

    Methods in org.keycloak.federation.ldap with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | LDAPFederationProvider.`preRemove(RealmModel realm, RoleModel role)`

  - ### Uses of RoleModel in org.keycloak.login

    Method parameters in org.keycloak.login with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | LoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`
    `LoginFormsProvider` | LoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`

  - ### Uses of RoleModel in org.keycloak.login.freemarker

    Method parameters in org.keycloak.login.freemarker with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`

  - ### Uses of RoleModel in org.keycloak.login.freemarker.model

    Methods in org.keycloak.login.freemarker.model that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `List<RoleModel>` | OAuthGrantBean.`getRealmRolesRequested()`
    `javax.ws.rs.core.MultivaluedMap<String,RoleModel>` | OAuthGrantBean.`getResourceRolesRequested()`

    Constructor parameters in org.keycloak.login.freemarker.model with type arguments of type RoleModel
    Constructor and Description
    `OAuthGrantBean(String code, ClientModel client, List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`
    `OAuthGrantBean(String code, ClientModel client, List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`

  - ### Uses of RoleModel in org.keycloak.models

    Methods in org.keycloak.models that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `RoleModel` | RoleContainerModel.`addRole(String name)`
    `RoleModel` | RoleContainerModel.`addRole(String id, String name)`
    `RoleModel` | RoleContainerModel.`getRole(String name)`
    `RoleModel` | RealmModel.`getRoleById(String id)`
    `RoleModel` | RealmProvider.`getRoleById(String id, RealmModel realm)`

    Methods in org.keycloak.models that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | UserModel.`getApplicationRoleMappings(ApplicationModel app)`
    `Set<RoleModel>` | ApplicationModel.`getApplicationScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RoleModel.`getComposites()`
    `Set<RoleModel>` | UserModel.`getRealmRoleMappings()`
    `Set<RoleModel>` | ClientModel.`getRealmScopeMappings()`
    `Set<RoleModel>` | UserModel.`getRoleMappings()`
    `Set<RoleModel>` | RoleContainerModel.`getRoles()`
    `Set<RoleModel>` | ClientModel.`getScopeMappings()`

    Methods in org.keycloak.models with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleModel.`addCompositeRole(RoleModel role)`
    `void` | ClientModel.`addScopeMapping(RoleModel role)`
    `void` | UserModel.`deleteRoleMapping(RoleModel role)`
    `void` | ClientModel.`deleteScopeMapping(RoleModel role)`
    `void` | UserModel.`grantRole(RoleModel role)`
    `boolean` | RoleModel.`hasRole(RoleModel role)`
    `boolean` | UserModel.`hasRole(RoleModel role)`
    `boolean` | ClientModel.`hasScope(RoleModel role)`
    `void` | UserFederationProvider.`preRemove(RealmModel realm, RoleModel role)` called before a role is removed.
    `void` | UserFederationManager.`preRemove(RealmModel realm, RoleModel role)`
    `void` | UserProvider.`preRemove(RealmModel realm, RoleModel role)`
    `void` | RoleModel.`removeCompositeRole(RoleModel role)`
    `boolean` | RoleContainerModel.`removeRole(RoleModel role)`

  - ### Uses of RoleModel in org.keycloak.models.cache

    Classes in org.keycloak.models.cache that implement RoleModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `RoleAdapter`

    Fields in org.keycloak.models.cache declared as RoleModel
    Modifier and Type | Field and Description
    --- | ---
    `protected RoleModel` | RoleAdapter.`updated`

    Fields in org.keycloak.models.cache with type parameters of type RoleModel
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,RoleModel>` | DefaultCacheRealmProvider.`managedRoles`

    Methods in org.keycloak.models.cache that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `RoleModel` | RealmAdapter.`addRole(String name)`
    `RoleModel` | ApplicationAdapter.`addRole(String name)`
    `RoleModel` | RealmAdapter.`addRole(String id, String name)`
    `RoleModel` | ApplicationAdapter.`addRole(String id, String name)`
    `RoleModel` | RealmAdapter.`getRole(String name)`
    `RoleModel` | ApplicationAdapter.`getRole(String name)`
    `RoleModel` | RealmAdapter.`getRoleById(String id)`
    `RoleModel` | DefaultCacheRealmProvider.`getRoleById(String id, RealmModel realm)`
    `RoleModel` | NoCacheRealmProvider.`getRoleById(String id, RealmModel realm)`

    Methods in org.keycloak.models.cache that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | UserAdapter.`getApplicationRoleMappings(ApplicationModel app)`
    `Set<RoleModel>` | ApplicationAdapter.`getApplicationScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RoleAdapter.`getComposites()`
    `Set<RoleModel>` | UserAdapter.`getRealmRoleMappings()`
    `Set<RoleModel>` | ClientAdapter.`getRealmScopeMappings()`
    `Set<RoleModel>` | UserAdapter.`getRoleMappings()`
    `Set<RoleModel>` | RealmAdapter.`getRoles()`
    `Set<RoleModel>` | ApplicationAdapter.`getRoles()`
    `Set<RoleModel>` | ClientAdapter.`getScopeMappings()`

    Methods in org.keycloak.models.cache with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleAdapter.`addCompositeRole(RoleModel role)`
    `void` | ClientAdapter.`addScopeMapping(RoleModel role)`
    `void` | UserAdapter.`deleteRoleMapping(RoleModel role)`
    `void` | ClientAdapter.`deleteScopeMapping(RoleModel role)`
    `void` | UserAdapter.`grantRole(RoleModel role)`
    `boolean` | UserAdapter.`hasRole(RoleModel role)`
    `boolean` | RoleAdapter.`hasRole(RoleModel role)`
    `boolean` | ClientAdapter.`hasScope(RoleModel role)`
    `boolean` | ApplicationAdapter.`hasScope(RoleModel role)`
    `void` | DefaultCacheUserProvider.`preRemove(RealmModel realm, RoleModel role)`
    `void` | NoCacheUserProvider.`preRemove(RealmModel realm, RoleModel role)`
    `void` | RoleAdapter.`removeCompositeRole(RoleModel role)`
    `boolean` | RealmAdapter.`removeRole(RoleModel role)`
    `boolean` | ApplicationAdapter.`removeRole(RoleModel role)`

  - ### Uses of RoleModel in org.keycloak.models.cache.entities

    Constructors in org.keycloak.models.cache.entities with parameters of type RoleModel
    Constructor and Description
    `CachedApplicationRole(String appId, RoleModel model, RealmModel realm)`
    `CachedRealmRole(RoleModel model, RealmModel realm)`
    `CachedRole(RoleModel model, RealmModel realm)`

  - ### Uses of RoleModel in org.keycloak.models.jpa

    Methods in org.keycloak.models.jpa that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `RoleModel` | RealmAdapter.`addRole(String name)`
    `RoleModel` | ApplicationAdapter.`addRole(String name)`
    `RoleModel` | RealmAdapter.`addRole(String id, String name)`
    `RoleModel` | ApplicationAdapter.`addRole(String id, String name)`
    `RoleModel` | RealmAdapter.`getRole(String name)`
    `RoleModel` | ApplicationAdapter.`getRole(String name)`
    `RoleModel` | RealmAdapter.`getRoleById(String id)`
    `RoleModel` | JpaRealmProvider.`getRoleById(String id, RealmModel realm)`

    Methods in org.keycloak.models.jpa that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | UserAdapter.`getApplicationRoleMappings(ApplicationModel app)`
    `Set<RoleModel>` | ApplicationAdapter.`getApplicationScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RoleAdapter.`getComposites()`
    `Set<RoleModel>` | UserAdapter.`getRealmRoleMappings()`
    `Set<RoleModel>` | ClientAdapter.`getRealmScopeMappings()`
    `Set<RoleModel>` | UserAdapter.`getRoleMappings()`
    `Set<RoleModel>` | RealmAdapter.`getRoles()`
    `Set<RoleModel>` | ApplicationAdapter.`getRoles()`
    `Set<RoleModel>` | ClientAdapter.`getScopeMappings()`

    Methods in org.keycloak.models.jpa with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleAdapter.`addCompositeRole(RoleModel role)`
    `void` | ClientAdapter.`addScopeMapping(RoleModel role)`
    `void` | UserAdapter.`deleteRoleMapping(RoleModel role)`
    `void` | ClientAdapter.`deleteScopeMapping(RoleModel role)`
    `protected javax.persistence.TypedQuery<ScopeMappingEntity>` | ClientAdapter.`getRealmScopeMappingQuery(RoleModel role)`
    `protected javax.persistence.TypedQuery<UserRoleMappingEntity>` | UserAdapter.`getUserRoleMappingEntityTypedQuery(RoleModel role)`
    `void` | UserAdapter.`grantRole(RoleModel role)`
    `boolean` | UserAdapter.`hasRole(RoleModel role)`
    `boolean` | RoleAdapter.`hasRole(RoleModel role)`
    `boolean` | ClientAdapter.`hasScope(RoleModel role)`
    `boolean` | ApplicationAdapter.`hasScope(RoleModel role)`
    `void` | JpaUserProvider.`preRemove(RealmModel realm, RoleModel role)`
    `void` | RoleAdapter.`removeCompositeRole(RoleModel role)`
    `boolean` | RealmAdapter.`removeRole(RoleModel role)`
    `boolean` | ApplicationAdapter.`removeRole(RoleModel roleModel)`
    `static RoleEntity` | RoleAdapter.`toRoleEntity(RoleModel model, javax.persistence.EntityManager em)`

  - ### Uses of RoleModel in org.keycloak.models.mongo.keycloak.adapters

    Methods in org.keycloak.models.mongo.keycloak.adapters that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `RoleModel` | RealmAdapter.`addRole(String name)`
    `RoleModel` | RealmAdapter.`addRole(String id, String name)`
    `RoleModel` | RealmAdapter.`getRoleById(String id)`
    `RoleModel` | MongoRealmProvider.`getRoleById(String id, RealmModel realm)`

    Methods in org.keycloak.models.mongo.keycloak.adapters that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | UserAdapter.`getApplicationRoleMappings(ApplicationModel app)`
    `Set<RoleModel>` | ApplicationAdapter.`getApplicationScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RoleAdapter.`getComposites()`
    `Set<RoleModel>` | UserAdapter.`getRealmRoleMappings()`
    `Set<RoleModel>` | ClientAdapter.`getRealmScopeMappings()`
    `Set<RoleModel>` | UserAdapter.`getRoleMappings()`
    `Set<RoleModel>` | RealmAdapter.`getRoles()`
    `Set<RoleModel>` | ApplicationAdapter.`getRoles()`
    `Set<RoleModel>` | ClientAdapter.`getScopeMappings()`

    Methods in org.keycloak.models.mongo.keycloak.adapters with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleAdapter.`addCompositeRole(RoleModel childRole)`
    `void` | ClientAdapter.`addScopeMapping(RoleModel role)`
    `void` | UserAdapter.`deleteRoleMapping(RoleModel role)`
    `void` | ClientAdapter.`deleteScopeMapping(RoleModel role)`
    `void` | UserAdapter.`grantRole(RoleModel role)`
    `boolean` | UserAdapter.`hasRole(RoleModel role)`
    `boolean` | RoleAdapter.`hasRole(RoleModel role)`
    `boolean` | ClientAdapter.`hasScope(RoleModel role)`
    `boolean` | ApplicationAdapter.`hasScope(RoleModel role)`
    `void` | MongoUserProvider.`preRemove(RealmModel realm, RoleModel role)`
    `void` | RoleAdapter.`removeCompositeRole(RoleModel childRole)`
    `boolean` | RealmAdapter.`removeRole(RoleModel role)`
    `boolean` | ApplicationAdapter.`removeRole(RoleModel role)`

  - ### Uses of RoleModel in org.keycloak.models.utils

    Methods in org.keycloak.models.utils that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | UserModelDelegate.`getApplicationRoleMappings(ApplicationModel app)`
    `Set<RoleModel>` | UserModelDelegate.`getRealmRoleMappings()`
    `Set<RoleModel>` | UserModelDelegate.`getRoleMappings()`

    Methods in org.keycloak.models.utils with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserModelDelegate.`deleteRoleMapping(RoleModel role)`
    `void` | UserModelDelegate.`grantRole(RoleModel role)`
    `boolean` | UserModelDelegate.`hasRole(RoleModel role)`
    `static boolean` | KeycloakModelUtils.`searchFor(RoleModel role, RoleModel composite, Set<RoleModel> visited)` Deep search if given role is descendant of composite role
    `static RoleRepresentation` | ModelToRepresentation.`toRepresentation(RoleModel role)`

    Method parameters in org.keycloak.models.utils with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | KeycloakModelUtils.`searchFor(RoleModel role, RoleModel composite, Set<RoleModel> visited)` Deep search if given role is descendant of composite role

  - ### Uses of RoleModel in org.keycloak.services.managers

    Methods in org.keycloak.services.managers that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | TokenManager.`getAccess(String scopeParam, ClientModel client, UserModel user)`
    `Set<RoleModel>` | AccessCode.`getRequestedRoles()`

    Methods in org.keycloak.services.managers with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | TokenManager.`addComposites(AccessToken token, RoleModel role)`
    `static void` | TokenManager.`applyScope(RoleModel role, RoleModel scope, Set<RoleModel> visited, Set<RoleModel> requested)`

    Method parameters in org.keycloak.services.managers with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `static void` | TokenManager.`applyScope(RoleModel role, RoleModel scope, Set<RoleModel> visited, Set<RoleModel> requested)`
    `static void` | TokenManager.`applyScope(RoleModel role, RoleModel scope, Set<RoleModel> visited, Set<RoleModel> requested)`
    `AccessToken` | TokenManager.`createClientAccessToken(Set<RoleModel> requestedRoles, RealmModel realm, ClientModel client, UserModel user, UserSessionModel session)`

  - ### Uses of RoleModel in org.keycloak.services.resources.admin

    Methods in org.keycloak.services.resources.admin that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected RoleModel` | RoleByIdResource.`getRoleModel(String id)`

    Methods in org.keycloak.services.resources.admin with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | RoleResource.`addComposites(List<RoleRepresentation> roles, RoleModel role)`
    `protected void` | RoleResource.`deleteComposites(List<RoleRepresentation> roles, RoleModel role)`
    `protected void` | RoleResource.`deleteRole(RoleModel role)`
    `protected Set<RoleRepresentation>` | RoleResource.`getApplicationRoleComposites(String appName, RoleModel role)`
    `protected Set<RoleRepresentation>` | RoleResource.`getRealmRoleComposites(RoleModel role)`
    `protected RoleRepresentation` | RoleResource.`getRole(RoleModel roleModel)`
    `protected Set<RoleRepresentation>` | RoleResource.`getRoleComposites(RoleModel role)`
    `protected void` | RoleResource.`updateRole(RoleRepresentation rep, RoleModel role)`

    Method parameters in org.keycloak.services.resources.admin with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected List<RoleRepresentation>` | UsersResource.`getAvailableRoles(UserModel user, Set<RoleModel> available)`

  - ### Uses of RoleModel in org.keycloak.test.tools.jobs

    Methods in org.keycloak.test.tools.jobs that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected RoleModel` | UsersJob.`findRole(Set<RoleModel> roles, String roleName)`

    Method parameters in org.keycloak.test.tools.jobs with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected RoleModel` | UsersJob.`findRole(Set<RoleModel> roles, String roleName)`
    `protected void` | UsersJob.`grantRole(UserModel user, String roleName, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles)`
    `protected void` | UsersJob.`grantRole(UserModel user, String roleName, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles)`
    `protected abstract void` | UsersJob.`runIteration(KeycloakSession session, RealmModel realm, Map<String,ApplicationModel> apps, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles, int counter)`
    `protected abstract void` | UsersJob.`runIteration(KeycloakSession session, RealmModel realm, Map<String,ApplicationModel> apps, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles, int counter)`
    `protected void` | UpdateUsersJob.`runIteration(KeycloakSession session, RealmModel realm, Map<String,ApplicationModel> apps, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles, int counter)`
    `protected void` | UpdateUsersJob.`runIteration(KeycloakSession session, RealmModel realm, Map<String,ApplicationModel> apps, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles, int counter)`
    `protected void` | DeleteUsersJob.`runIteration(KeycloakSession session, RealmModel realm, Map<String,ApplicationModel> apps, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles, int counter)`
    `protected void` | DeleteUsersJob.`runIteration(KeycloakSession session, RealmModel realm, Map<String,ApplicationModel> apps, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles, int counter)`
    `protected void` | CreateUsersJob.`runIteration(KeycloakSession session, RealmModel realm, Map<String,ApplicationModel> apps, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles, int counter)`
    `protected void` | CreateUsersJob.`runIteration(KeycloakSession session, RealmModel realm, Map<String,ApplicationModel> apps, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles, int counter)`

  - ### Uses of RoleModel in org.keycloak.testutils

    Methods in org.keycloak.testutils with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | DummyUserFederationProvider.`preRemove(RealmModel realm, RoleModel role)`

Copyright © 2014. All Rights Reserved.