Class SimpleAuthorityMapper
- java.lang.Object
-
- org.springframework.security.core.authority.mapping.SimpleAuthorityMapper
-
- All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean
,GrantedAuthoritiesMapper
public final class SimpleAuthorityMapper extends java.lang.Object implements GrantedAuthoritiesMapper, org.springframework.beans.factory.InitializingBean
Simple one-to-oneGrantedAuthoritiesMapper
which allows for case conversion of the authority name and the addition of a string prefix (which defaults toROLE_
).- Since:
- 3.1
-
-
Constructor Summary
Constructors Constructor Description SimpleAuthorityMapper()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
java.util.Set<GrantedAuthority>
mapAuthorities(java.util.Collection<? extends GrantedAuthority> authorities)
Creates a mapping of the supplied authorities based on the case-conversion and prefix settings.void
setConvertToLowerCase(boolean convertToLowerCase)
Whether to convert the authority value to lower case in the mapping.void
setConvertToUpperCase(boolean convertToUpperCase)
Whether to convert the authority value to upper case in the mapping.void
setDefaultAuthority(java.lang.String authority)
Sets a default authority to be assigned to all usersvoid
setPrefix(java.lang.String prefix)
Sets the prefix which should be added to the authority name (if it doesn't already exist)
-
-
-
Method Detail
-
afterPropertiesSet
public void afterPropertiesSet()
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
-
mapAuthorities
public java.util.Set<GrantedAuthority> mapAuthorities(java.util.Collection<? extends GrantedAuthority> authorities)
Creates a mapping of the supplied authorities based on the case-conversion and prefix settings. The mapping will be one-to-one unless duplicates are produced during the conversion. If a default authority has been set, this will also be assigned to each mapping.- Specified by:
mapAuthorities
in interfaceGrantedAuthoritiesMapper
- Parameters:
authorities
- the original authorities- Returns:
- the converted set of authorities
-
setPrefix
public void setPrefix(java.lang.String prefix)
Sets the prefix which should be added to the authority name (if it doesn't already exist)- Parameters:
prefix
- the prefix, typically to satisfy the behaviour of anAccessDecisionVoter
.
-
setConvertToUpperCase
public void setConvertToUpperCase(boolean convertToUpperCase)
Whether to convert the authority value to upper case in the mapping.- Parameters:
convertToUpperCase
- defaults tofalse
-
setConvertToLowerCase
public void setConvertToLowerCase(boolean convertToLowerCase)
Whether to convert the authority value to lower case in the mapping.- Parameters:
convertToLowerCase
- defaults tofalse
-
setDefaultAuthority
public void setDefaultAuthority(java.lang.String authority)
Sets a default authority to be assigned to all users- Parameters:
authority
- the name of the authority to be assigned to all users.
-
-