org.springframework.cloud.common.security.support

Class ExternalOauth2ResourceAuthoritiesMapper

java.lang.Object

org.springframework.cloud.common.security.support.ExternalOauth2ResourceAuthoritiesMapper

All Implemented Interfaces:

AuthoritiesMapper

public class ExternalOauth2ResourceAuthoritiesMapper
extends Object
implements AuthoritiesMapper

AuthoritiesMapper that looks up CoreSecurityRoles from an external HTTP resource. Requests to the external HTTP resource are authenticated by forwarding the user's access token. The external resource's response body MUST be a JSON array containing strings with values corresponding to CoreSecurityRoles.key values. For example, a response containing ["VIEW", "CREATE"] would grant the user ROLE_VIEW, ROLE_CREATE,

Author:

Mike Heath, Gunnar Hillert

Field Summary

Fields

Modifier and Type	Field and Description
static org.springframework.security.core.GrantedAuthority	CREATE
static org.springframework.security.core.GrantedAuthority	DEPLOY
static org.springframework.security.core.GrantedAuthority	DESTROY
static org.springframework.security.core.GrantedAuthority	MANAGE
static org.springframework.security.core.GrantedAuthority	MODIFY
static org.springframework.security.core.GrantedAuthority	SCHEDULE
static org.springframework.security.core.GrantedAuthority	VIEW

Constructor Summary

Constructors

Constructor and Description
ExternalOauth2ResourceAuthoritiesMapper(URI roleProviderUri)

Method Summary

Modifier and Type	Method and Description
Set<org.springframework.security.core.GrantedAuthority>	mapScopesToAuthorities(String providerId, Set<String> scopes, String token) Map the provided Scopes to authorities.

Methods inherited from class java.lang.Object

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

Field Detail

CREATE

public static final org.springframework.security.core.GrantedAuthority CREATE

DEPLOY

public static final org.springframework.security.core.GrantedAuthority DEPLOY

DESTROY

public static final org.springframework.security.core.GrantedAuthority DESTROY

MANAGE

public static final org.springframework.security.core.GrantedAuthority MANAGE

MODIFY

public static final org.springframework.security.core.GrantedAuthority MODIFY

SCHEDULE

public static final org.springframework.security.core.GrantedAuthority SCHEDULE

VIEW

public static final org.springframework.security.core.GrantedAuthority VIEW

Constructor Detail

ExternalOauth2ResourceAuthoritiesMapper

public ExternalOauth2ResourceAuthoritiesMapper(URI roleProviderUri)

Parameters:

roleProviderUri - a HTTP GET request is sent to this URI to fetch the user's security roles

Method Detail

mapScopesToAuthorities

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

Description copied from interface: AuthoritiesMapper

Map the provided Scopes to authorities.

Specified by:

mapScopesToAuthorities in interface AuthoritiesMapper

Parameters:

providerId - If null, then the default providerId is used

scopes - the scopes to map

token - some implementation may need to make additional requests

Returns:

the mapped authorities