Package org.springframework.security.oauth2.core.user

Class OAuth2UserAuthority

java.lang.Object
org.springframework.security.oauth2.core.user.OAuth2UserAuthority
All Implemented Interfaces:
Serializable, GrantedAuthority
Direct Known Subclasses:
OidcUserAuthority
public class OAuth2UserAuthority extends Object implements GrantedAuthority
A GrantedAuthority that may be associated to an OAuth2User.
Since:
5.0
See Also:

  • Constructor Details

    • OAuth2UserAuthority

      public OAuth2UserAuthority(Map<String,Object> attributes)
      Constructs a OAuth2UserAuthority using the provided parameters and defaults getAuthority() to OAUTH2_USER.
      Parameters:
      attributes - the attributes about the user

    • OAuth2UserAuthority

      public OAuth2UserAuthority(Map<String,Object> attributes, @Nullable String userNameAttributeName)
      Constructs a OAuth2UserAuthority using the provided parameters and defaults getAuthority() to OAUTH2_USER.
      Parameters:
      attributes - the attributes about the user
      userNameAttributeName - the attribute name used to access the user's name from the attributes
      Since:
      6.4

    • OAuth2UserAuthority

      public OAuth2UserAuthority(String authority, Map<String,Object> attributes)
      Constructs a OAuth2UserAuthority using the provided parameters.
      Parameters:
      authority - the authority granted to the user
      attributes - the attributes about the user

    • OAuth2UserAuthority

      public OAuth2UserAuthority(String authority, Map<String,Object> attributes, String userNameAttributeName)
      Constructs a OAuth2UserAuthority using the provided parameters.
      Parameters:
      authority - the authority granted to the user
      attributes - the attributes about the user
      userNameAttributeName - the attribute name used to access the user's name from the attributes
      Since:
      6.4

  • Method Details

    • getAuthority

      public String getAuthority()
      Description copied from interface: GrantedAuthority
      If the GrantedAuthority can be represented as a String and that String is sufficient in precision to be relied upon for an access control decision by an AuthorizationManager (or delegate), this method should return such a String.

      If the GrantedAuthority cannot be expressed with sufficient precision as a String, null should be returned. Returning null will require an AccessDecisionManager (or delegate) to specifically support the GrantedAuthority implementation, so returning null should be avoided unless actually required.

      Specified by:
      getAuthority in interface GrantedAuthority
      Returns:
      a representation of the granted authority (or null if the granted authority cannot be expressed as a String with sufficient precision).

    • getAttributes

      public Map<String,Object> getAttributes()
      Returns the attributes about the user.
      Returns:
      a Map of attributes about the user

    • getUserNameAttributeName

      @Nullable public String getUserNameAttributeName()
      Returns the attribute name used to access the user's name from the attributes.
      Returns:
      the attribute name used to access the user's name from the attributes
      Since:
      6.4

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object