org.springframework.cloud.common.security.support

Class ExternalOauth2ResourceAuthoritiesExtractor

java.lang.Object

org.springframework.cloud.common.security.support.ExternalOauth2ResourceAuthoritiesExtractor

All Implemented Interfaces:

org.springframework.boot.autoconfigure.security.oauth2.resource.AuthoritiesExtractor

public class ExternalOauth2ResourceAuthoritiesExtractor
extends Object
implements org.springframework.boot.autoconfigure.security.oauth2.resource.AuthoritiesExtractor

Spring Cloud AuthoritiesExtractor 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

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
ExternalOauth2ResourceAuthoritiesExtractor(org.springframework.security.oauth2.client.OAuth2RestTemplate restTemplate, URI roleProviderUri)

Method Summary

Modifier and Type	Method and Description
List<org.springframework.security.core.GrantedAuthority>	extractAuthorities(Map<String,Object> map)

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

ExternalOauth2ResourceAuthoritiesExtractor

public ExternalOauth2ResourceAuthoritiesExtractor(org.springframework.security.oauth2.client.OAuth2RestTemplate restTemplate,
                                                  URI roleProviderUri)

Parameters:

restTemplate - used for acquiring the user's access token and requesting the user's security roles

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

Method Detail

extractAuthorities

public List<org.springframework.security.core.GrantedAuthority> extractAuthorities(Map<String,Object> map)

Specified by:

extractAuthorities in interface org.springframework.boot.autoconfigure.security.oauth2.resource.AuthoritiesExtractor