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

Class OAuth2UserAuthority

java.lang.Object

org.springframework.security.oauth2.core.user.OAuth2UserAuthority

All Implemented Interfaces:

java.io.Serializable, GrantedAuthority

Direct Known Subclasses:

OidcUserAuthority

public class OAuth2UserAuthority
extends java.lang.Object
implements 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

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()	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 AccessDecisionManager (or delegate), this method should return such a String.
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()

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 AccessDecisionManager (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 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