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
AGrantedAuthority
that may be associated to anOAuth2User
.- 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 aOAuth2UserAuthority
using the provided parameters.OAuth2UserAuthority(java.util.Map<java.lang.String,java.lang.Object> attributes)
Constructs aOAuth2UserAuthority
using the provided parameters and defaultsgetAuthority()
toROLE_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()
If theGrantedAuthority
can be represented as aString
and thatString
is sufficient in precision to be relied upon for an access control decision by anAccessDecisionManager
(or delegate), this method should return such aString
.int
hashCode()
java.lang.String
toString()
-
-
-
Constructor Detail
-
OAuth2UserAuthority
public OAuth2UserAuthority(java.util.Map<java.lang.String,java.lang.Object> attributes)
Constructs aOAuth2UserAuthority
using the provided parameters and defaultsgetAuthority()
toROLE_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 aOAuth2UserAuthority
using the provided parameters.- Parameters:
authority
- the authority granted to the userattributes
- the attributes about the user
-
-
Method Detail
-
getAuthority
public java.lang.String getAuthority()
Description copied from interface:GrantedAuthority
If theGrantedAuthority
can be represented as aString
and thatString
is sufficient in precision to be relied upon for an access control decision by anAccessDecisionManager
(or delegate), this method should return such aString
.If the
GrantedAuthority
cannot be expressed with sufficient precision as aString
,null
should be returned. Returningnull
will require anAccessDecisionManager
(or delegate) to specifically support theGrantedAuthority
implementation, so returningnull
should be avoided unless actually required.- Specified by:
getAuthority
in interfaceGrantedAuthority
- Returns:
- a representation of the granted authority (or
null
if the granted authority cannot be expressed as aString
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 classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-