Class OAuth2UserAuthority

  • All Implemented Interfaces:
    java.io.Serializable, org.springframework.security.core.GrantedAuthority
    Direct Known Subclasses:
    OidcUserAuthority

    public class OAuth2UserAuthority
    extends java.lang.Object
    implements org.springframework.security.core.GrantedAuthority
    A GrantedAuthority that may be associated to an OAuth2User.
    Since:
    5.0
    See Also:
    OAuth2User, Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      OAuth2UserAuthority​(java.lang.String authority, java.util.Map<java.lang.String,​java.lang.Object> attributes)
      Constructs a OAuth2UserAuthority using the provided parameters.
      OAuth2UserAuthority​(java.util.Map<java.lang.String,​java.lang.Object> attributes)
      Constructs a OAuth2UserAuthority using the provided parameters and defaults getAuthority() to ROLE_USER.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.util.Map<java.lang.String,​java.lang.Object> getAttributes()
      Returns the attributes about the user.
      java.lang.String getAuthority()  
      int hashCode()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • OAuth2UserAuthority

        public OAuth2UserAuthority​(java.util.Map<java.lang.String,​java.lang.Object> attributes)
        Constructs a OAuth2UserAuthority using the provided parameters and defaults getAuthority() to ROLE_USER.
        Parameters:
        attributes - the attributes about the user
      • OAuth2UserAuthority

        public OAuth2UserAuthority​(java.lang.String authority,
                                   java.util.Map<java.lang.String,​java.lang.Object> attributes)
        Constructs a OAuth2UserAuthority using the provided parameters.
        Parameters:
        authority - the authority granted to the user
        attributes - the attributes about the user
    • Method Detail

      • getAuthority

        public java.lang.String getAuthority()
        Specified by:
        getAuthority in interface org.springframework.security.core.GrantedAuthority
      • getAttributes

        public java.util.Map<java.lang.String,​java.lang.Object> getAttributes()
        Returns the attributes about the user.
        Returns:
        a Map of attributes about the user
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object