Package org.springframework.security.core.authority.mapping

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 Object implements GrantedAuthoritiesMapper, org.springframework.beans.factory.InitializingBean
Simple one-to-one GrantedAuthoritiesMapper which allows for case conversion of the authority name and the addition of a string prefix (which defaults to ROLE_ ).
Since:
3.1

  • Constructor Details

    • SimpleAuthorityMapper

      public SimpleAuthorityMapper()

  • Method Details

    • afterPropertiesSet

      public void afterPropertiesSet()
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

    • mapAuthorities

      public Set<GrantedAuthority> mapAuthorities(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 interface GrantedAuthoritiesMapper
      Parameters:
      authorities - the original authorities
      Returns:
      the converted set of authorities

    • setPrefix

      public void setPrefix(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 an AccessDecisionVoter.

    • setConvertToUpperCase

      public void setConvertToUpperCase(boolean convertToUpperCase)
      Whether to convert the authority value to upper case in the mapping.
      Parameters:
      convertToUpperCase - defaults to false

    • setConvertToLowerCase

      public void setConvertToLowerCase(boolean convertToLowerCase)
      Whether to convert the authority value to lower case in the mapping.
      Parameters:
      convertToLowerCase - defaults to false

    • setDefaultAuthority

      public void setDefaultAuthority(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.