Package io.jmix.oidc.claimsmapper

Class DefaultClaimsRolesMapper

java.lang.Object

io.jmix.oidc.claimsmapper.BaseClaimsRolesMapper

io.jmix.oidc.claimsmapper.DefaultClaimsRolesMapper

All Implemented Interfaces:

ClaimsRolesMapper

public class DefaultClaimsRolesMapper
extends BaseClaimsRolesMapper

Default ClaimsRolesMapper implementation that takes OidcUser role names and transforms roles names to resource and row-level roles using role name prefixes.

Roles names are taken from a special claim. Claim name is taken from the rolesClaimName property. The default value is taken from the OidcProperties.DefaultClaimsRolesMapperConfig.getRolesClaimName() and may be changed using the corresponding application property.

Role names from the user attribute are mapped to the resource and row-level roles using resourceRolePrefix and rowLevelRolePrefix prefixes, e.g. if the resourceRolePrefix is "resource$" then OIDC role with the name "resource$system-full-access" will be mapped to Jmix role with the "system-full-access" code.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	resourceRolePrefix
protected String	rolesClaimName
protected String	rowLevelRolePrefix

Fields inherited from class io.jmix.oidc.claimsmapper.BaseClaimsRolesMapper

resourceRoleRepository, roleGrantedAuthorityUtils, rowLevelRoleRepository

Constructor Summary

Constructors

Constructor	Description
DefaultClaimsRolesMapper(ResourceRoleRepository resourceRoleRepository, RowLevelRoleRepository rowLevelRoleRepository, RoleGrantedAuthorityUtils roleGrantedAuthorityUtils)

Method Summary

Modifier and Type	Method	Description
String	getResourceRolePrefix()
protected Collection<String>	getResourceRolesCodes(Map<String,Object> claims)
String	getRolesClaimName()
protected Collection<String>	getRolesCodes(Map<String,Object> claims, String rolesClaimName, String oidcRoleNamePrefix)
protected Collection<String>	getRowLevelRoleCodes(Map<String,Object> claims)
String	getRowLevelRolePrefix()
void	setResourceRolePrefix(String resourceRolePrefix)
void	setRolesClaimName(String rolesClaimName)
void	setRowLevelRolePrefix(String rowLevelRolePrefix)

Methods inherited from class io.jmix.oidc.claimsmapper.BaseClaimsRolesMapper

toGrantedAuthorities, toResourceRoles, toRowLevelRoles

Methods inherited from class java.lang.Object

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

Field Details

rolesClaimName

protected String rolesClaimName

resourceRolePrefix

protected String resourceRolePrefix

rowLevelRolePrefix

protected String rowLevelRolePrefix

Constructor Details

DefaultClaimsRolesMapper

public DefaultClaimsRolesMapper(ResourceRoleRepository resourceRoleRepository,
 RowLevelRoleRepository rowLevelRoleRepository,
 RoleGrantedAuthorityUtils roleGrantedAuthorityUtils)

Method Details

getResourceRolesCodes

protected Collection<String> getResourceRolesCodes(Map<String,Object> claims)

Overrides:

getResourceRolesCodes in class BaseClaimsRolesMapper

getRowLevelRoleCodes

protected Collection<String> getRowLevelRoleCodes(Map<String,Object> claims)

Overrides:

getRowLevelRoleCodes in class BaseClaimsRolesMapper

getRolesCodes

protected Collection<String> getRolesCodes(Map<String,Object> claims,
 String rolesClaimName,
 String oidcRoleNamePrefix)

getRolesClaimName

public String getRolesClaimName()

setRolesClaimName

public void setRolesClaimName(String rolesClaimName)

getResourceRolePrefix

public String getResourceRolePrefix()

setResourceRolePrefix

public void setResourceRolePrefix(String resourceRolePrefix)

getRowLevelRolePrefix

public String getRowLevelRolePrefix()

setRowLevelRolePrefix

public void setRowLevelRolePrefix(String rowLevelRolePrefix)