org.springframework.cloud.common.security.support

Class DefaultAuthoritiesMapper

java.lang.Object

org.springframework.cloud.common.security.support.DefaultAuthoritiesMapper

All Implemented Interfaces:

AuthoritiesMapper

public class DefaultAuthoritiesMapper
extends Object
implements AuthoritiesMapper

Default AuthoritiesMapper.

Since:

1.3.0

Author:

Gunnar Hillert

Constructor Summary

Constructors

Constructor and Description
DefaultAuthoritiesMapper(Map<String,ProviderRoleMapping> providerRoleMappings, String defaultProviderId)
DefaultAuthoritiesMapper(String providerId, boolean mapOAuthScopes) Convenience constructor that will create a DefaultAuthoritiesMapper with a single ProviderRoleMapping.
DefaultAuthoritiesMapper(String providerId, boolean mapOAuthScopes, Map<String,String> roleMappings) Convenience constructor that will create a DefaultAuthoritiesMapper with a single ProviderRoleMapping.
DefaultAuthoritiesMapper(String providerId, ProviderRoleMapping providerRoleMapping) Convenience constructor that will create a DefaultAuthoritiesMapper with a single ProviderRoleMapping.

Method Summary

Modifier and Type	Method and Description
Set<org.springframework.security.core.GrantedAuthority>	mapScopesToAuthorities(String clientIdParam, Set<String> scopes, String token) The returned List of GrantedAuthoritys contains all roles from CoreSecurityRoles.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAuthoritiesMapper

public DefaultAuthoritiesMapper(Map<String,ProviderRoleMapping> providerRoleMappings,
                                String defaultProviderId)

DefaultAuthoritiesMapper

public DefaultAuthoritiesMapper(String providerId,
                                boolean mapOAuthScopes,
                                Map<String,String> roleMappings)

Convenience constructor that will create a DefaultAuthoritiesMapper with a single ProviderRoleMapping.

Parameters:

providerId - Create a ProviderRoleMapping with the specified providerId

mapOAuthScopes - Shall OAuth scopes be considered?

roleMappings - Used to populate the ProviderRoleMapping

DefaultAuthoritiesMapper

public DefaultAuthoritiesMapper(String providerId,
                                boolean mapOAuthScopes)

Convenience constructor that will create a DefaultAuthoritiesMapper with a single ProviderRoleMapping.

Parameters:

providerId - The provider id for the ProviderRoleMapping

mapOAuthScopes - Consider scopes?

DefaultAuthoritiesMapper

public DefaultAuthoritiesMapper(String providerId,
                                ProviderRoleMapping providerRoleMapping)

Convenience constructor that will create a DefaultAuthoritiesMapper with a single ProviderRoleMapping.

Parameters:

providerId - The provider id for the ProviderRoleMapping

providerRoleMapping - The role mappings to add to the ProviderRoleMapping

Method Detail

mapScopesToAuthorities

public Set<org.springframework.security.core.GrantedAuthority> mapScopesToAuthorities(String clientIdParam,
                                                                                      Set<String> scopes,
                                                                                      String token)

The returned List of GrantedAuthoritys contains all roles from CoreSecurityRoles. The roles are prefixed with the value specified in GrantedAuthorityDefaults.

Specified by:

mapScopesToAuthorities in interface AuthoritiesMapper

Parameters:

clientIdParam - If null, the default defaultProviderId is used

scopes - Must not be null

token - Ignored in this implementation

Returns:

the mapped authorities