java.lang.Object
- org.keycloak.protocol.saml.mappers.RoleNameMapper

All Implemented Interfaces:

org.keycloak.protocol.ProtocolMapper, SAMLRoleNameMapper, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>
```
public class RoleNameMapper
extends Object
implements SAMLRoleNameMapper, org.keycloak.protocol.ProtocolMapper
```
Map an assigned role to a different position and name in the token

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields
Modifier and Type Field Description

static String NEW_ROLE_NAME

static String PROVIDER_ID

static String ROLE_CONFIG

Constructor Summary

Constructors
Constructor Description

RoleNameMapper()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`static org.keycloak.models.ProtocolMapperModel`	`create(String name, String role, String newName)`
`org.keycloak.protocol.ProtocolMapper`	`create(org.keycloak.models.KeycloakSession session)`
`List<org.keycloak.provider.ProviderConfigProperty>`	`getConfigProperties()`
`String`	`getDisplayCategory()`
`String`	`getDisplayType()`
`String`	`getHelpText()`
`String`	`getId()`
`String`	`getProtocol()`
`void`	`init(org.keycloak.Config.Scope config)`
`String`	`mapName(org.keycloak.models.ProtocolMapperModel model, org.keycloak.models.RoleModel roleModel)`
`void`	`postInit(org.keycloak.models.KeycloakSessionFactory factory)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig

Methods inherited from interface org.keycloak.protocol.ProtocolMapper
getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order

- Field Detail
  - ROLE_CONFIG
```
public static final String ROLE_CONFIG
```
    See Also:
    
    Constant Field Values
  - NEW_ROLE_NAME
```
public static String NEW_ROLE_NAME
```
  - PROVIDER_ID
```
public static final String PROVIDER_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RoleNameMapper
```
public RoleNameMapper()
```
- Method Detail
  - getConfigProperties
```
public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
```
    Specified by:
    
    getConfigProperties in interface org.keycloak.provider.ConfiguredProvider
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>
  - getDisplayType
```
public String getDisplayType()
```
    Specified by:
    
    getDisplayType in interface org.keycloak.protocol.ProtocolMapper
  - getDisplayCategory
```
public String getDisplayCategory()
```
    Specified by:
    
    getDisplayCategory in interface org.keycloak.protocol.ProtocolMapper
  - getHelpText
```
public String getHelpText()
```
    Specified by:
    
    getHelpText in interface org.keycloak.provider.ConfiguredProvider
  - mapName
```
public String mapName(org.keycloak.models.ProtocolMapperModel model,
                      org.keycloak.models.RoleModel roleModel)
```
    Specified by:
    
    mapName in interface SAMLRoleNameMapper
  - create
```
public static org.keycloak.models.ProtocolMapperModel create(String name,
                                                             String role,
                                                             String newName)
```
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface org.keycloak.protocol.ProtocolMapper
  - close
```
public void close()
```
    Specified by:
    
    close in interface org.keycloak.provider.Provider
    
    Specified by:
    
    close in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>
  - init
```
public void init(org.keycloak.Config.Scope config)
```
    Specified by:
    
    init in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>
  - create
```
public final org.keycloak.protocol.ProtocolMapper create(org.keycloak.models.KeycloakSession session)
```
    Specified by:
    
    create in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>
  - postInit
```
public void postInit(org.keycloak.models.KeycloakSessionFactory factory)
```
    Specified by:
    
    postInit in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

Modifier and Type	Field	Description
`static String`	`NEW_ROLE_NAME`
`static String`	`PROVIDER_ID`
`static String`	`ROLE_CONFIG`

Class RoleNameMapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

Methods inherited from interface org.keycloak.provider.ProviderFactory

Field Detail

ROLE_CONFIG

NEW_ROLE_NAME

PROVIDER_ID

Constructor Detail

RoleNameMapper

Method Detail

getConfigProperties

getId

getDisplayType

getDisplayCategory

getHelpText

mapName

create

getProtocol

close

init

create

postInit