org.springframework.cloud.common.security.support

Class MappingJwtGrantedAuthoritiesConverter

java.lang.Object

org.springframework.cloud.common.security.support.MappingJwtGrantedAuthoritiesConverter

All Implemented Interfaces:

org.springframework.core.convert.converter.Converter<org.springframework.security.oauth2.jwt.Jwt,Collection<org.springframework.security.core.GrantedAuthority>>

public final class MappingJwtGrantedAuthoritiesConverter
extends Object
implements org.springframework.core.convert.converter.Converter<org.springframework.security.oauth2.jwt.Jwt,Collection<org.springframework.security.core.GrantedAuthority>>

Extracts the GrantedAuthoritys from scope attributes typically found in a Jwt.

Constructor Summary

Constructors

Constructor and Description
MappingJwtGrantedAuthoritiesConverter()

Method Summary

Modifier and Type	Method and Description
Collection<org.springframework.security.core.GrantedAuthority>	convert(org.springframework.security.oauth2.jwt.Jwt jwt) Extract GrantedAuthoritys from the given Jwt.
void	setAuthoritiesClaimName(String authoritiesClaimName) Sets the name of token claim to use for mapping authorities by this converter.
void	setAuthoritiesMapping(Map<String,String> authoritiesMapping) Set the mapping from resolved authorities from jwt into granted authorities.
void	setAuthorityPrefix(String authorityPrefix) Sets the prefix to use for authorities mapped by this converter.

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingJwtGrantedAuthoritiesConverter

public MappingJwtGrantedAuthoritiesConverter()

Method Detail

convert

public Collection<org.springframework.security.core.GrantedAuthority> convert(org.springframework.security.oauth2.jwt.Jwt jwt)

Extract GrantedAuthoritys from the given Jwt.

Specified by:

convert in interface org.springframework.core.convert.converter.Converter<org.springframework.security.oauth2.jwt.Jwt,Collection<org.springframework.security.core.GrantedAuthority>>

Parameters:

jwt - The Jwt token

Returns:

The authorities read from the token scopes

setAuthorityPrefix

public void setAuthorityPrefix(String authorityPrefix)

Sets the prefix to use for authorities mapped by this converter. Defaults to JwtGrantedAuthoritiesConverter#DEFAULT_AUTHORITY_PREFIX.

Parameters:

authorityPrefix - The authority prefix

setAuthoritiesClaimName

public void setAuthoritiesClaimName(String authoritiesClaimName)

Sets the name of token claim to use for mapping authorities by this converter. Defaults to JwtGrantedAuthoritiesConverter#WELL_KNOWN_AUTHORITIES_CLAIM_NAMES.

Parameters:

authoritiesClaimName - The token claim name to map authorities

setAuthoritiesMapping

public void setAuthoritiesMapping(Map<String,String> authoritiesMapping)

Set the mapping from resolved authorities from jwt into granted authorities.

Parameters:

authoritiesMapping - the authoritiesMapping to set