Package io.jmix.oidc.claimsmapper

Class BaseClaimsRolesMapper

java.lang.Object

io.jmix.oidc.claimsmapper.BaseClaimsRolesMapper

All Implemented Interfaces:

ClaimsRolesMapper

Direct Known Subclasses:

DefaultClaimsRolesMapper

public class BaseClaimsRolesMapper
extends Object
implements ClaimsRolesMapper

ClaimsRolesMapper that can be used as super-class for your own ClaimsRolesMapper implementations. The child classes must override the getResourceRolesCodes(Map) or/and getRowLevelRoleCodes(Map) methods. The behavior for finding roles with given codes and transforming them into a collection of GrantedAuthority is already implemented in the current class.

Field Summary

Fields

Modifier and Type	Field	Description
protected ResourceRoleRepository	resourceRoleRepository
protected RoleGrantedAuthorityUtils	roleGrantedAuthorityUtils
protected RowLevelRoleRepository	rowLevelRoleRepository

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Collection<String>	getResourceRolesCodes(Map<String,Object> claims)
protected Collection<String>	getRowLevelRoleCodes(Map<String,Object> claims)
Collection<? extends org.springframework.security.core.GrantedAuthority>	toGrantedAuthorities(Map<String,Object> claims)	Transforms collection of roles returned by toResourceRoles(Map) and toRowLevelRoles(Map) into a collection of GrantedAuthority.
Collection<ResourceRole>	toResourceRoles(Map<String,Object> claims)
Collection<RowLevelRole>	toRowLevelRoles(Map<String,Object> claims)

Methods inherited from class java.lang.Object

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

Field Details

rowLevelRoleRepository

protected RowLevelRoleRepository rowLevelRoleRepository

resourceRoleRepository

protected ResourceRoleRepository resourceRoleRepository

roleGrantedAuthorityUtils

protected RoleGrantedAuthorityUtils roleGrantedAuthorityUtils

Constructor Details

BaseClaimsRolesMapper

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

Method Details

toResourceRoles

public Collection<ResourceRole> toResourceRoles(Map<String,Object> claims)

Specified by:

toResourceRoles in interface ClaimsRolesMapper

toRowLevelRoles

public Collection<RowLevelRole> toRowLevelRoles(Map<String,Object> claims)

Specified by:

toRowLevelRoles in interface ClaimsRolesMapper

getResourceRolesCodes

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

getRowLevelRoleCodes

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

toGrantedAuthorities

public Collection<? extends org.springframework.security.core.GrantedAuthority> toGrantedAuthorities(Map<String,Object> claims)

Transforms collection of roles returned by toResourceRoles(Map) and toRowLevelRoles(Map) into a collection of GrantedAuthority.

Specified by:

toGrantedAuthorities in interface ClaimsRolesMapper

Parameters:

claims - pieces of information about the user returned by the OpenID Provider

Returns:

a collection of granted authorities that contain information about resource and row-level roles available to the user