Package org.springframework.security.oauth2.core

Class DefaultOAuth2AuthenticatedPrincipal

java.lang.Object

org.springframework.security.oauth2.core.DefaultOAuth2AuthenticatedPrincipal

All Implemented Interfaces:

Serializable, AuthenticatedPrincipal, OAuth2AuthenticatedPrincipal

public final class DefaultOAuth2AuthenticatedPrincipal
extends Object
implements OAuth2AuthenticatedPrincipal, Serializable

A domain object that wraps the attributes of an OAuth 2.0 token.

Since:

5.2

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultOAuth2AuthenticatedPrincipal(String name, Map<String,Object> attributes, Collection<GrantedAuthority> authorities)	Constructs an DefaultOAuth2AuthenticatedPrincipal using the provided parameters.
DefaultOAuth2AuthenticatedPrincipal(Map<String,Object> attributes, Collection<GrantedAuthority> authorities)	Constructs an DefaultOAuth2AuthenticatedPrincipal using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAttributes()	Gets the attributes of the OAuth 2.0 token in map form.
Collection<? extends GrantedAuthority>	getAuthorities()	Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 token
String	getName()	Returns the name of the authenticated Principal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.security.oauth2.core.OAuth2AuthenticatedPrincipal

getAttribute

Constructor Details

DefaultOAuth2AuthenticatedPrincipal

public DefaultOAuth2AuthenticatedPrincipal(Map<String,Object> attributes,
 Collection<GrantedAuthority> authorities)

Constructs an DefaultOAuth2AuthenticatedPrincipal using the provided parameters.

Parameters:

attributes - the attributes of the OAuth 2.0 token

authorities - the authorities of the OAuth 2.0 token

DefaultOAuth2AuthenticatedPrincipal

public DefaultOAuth2AuthenticatedPrincipal(String name,
 Map<String,Object> attributes,
 Collection<GrantedAuthority> authorities)

Constructs an DefaultOAuth2AuthenticatedPrincipal using the provided parameters.

Parameters:

name - the name attached to the OAuth 2.0 token

attributes - the attributes of the OAuth 2.0 token

authorities - the authorities of the OAuth 2.0 token

Method Details

getAttributes

public Map<String,Object> getAttributes()

Gets the attributes of the OAuth 2.0 token in map form.

Specified by:

getAttributes in interface OAuth2AuthenticatedPrincipal

Returns:

a Map of the attribute's objects keyed by the attribute's names

getAuthorities

public Collection<? extends GrantedAuthority> getAuthorities()

Description copied from interface: OAuth2AuthenticatedPrincipal

Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 token

Specified by:

getAuthorities in interface OAuth2AuthenticatedPrincipal

Returns:

the OAuth 2.0 token authorities

getName

public String getName()

Description copied from interface: AuthenticatedPrincipal

Returns the name of the authenticated Principal. Never null.

Specified by:

getName in interface AuthenticatedPrincipal

Returns:

the name of the authenticated Principal