Package org.springframework.security.oauth2.server.resource.introspection

Class OAuth2IntrospectionAuthenticatedPrincipal

java.lang.Object

org.springframework.security.oauth2.server.resource.introspection.OAuth2IntrospectionAuthenticatedPrincipal

All Implemented Interfaces:

Serializable, AuthenticatedPrincipal, ClaimAccessor, OAuth2AuthenticatedPrincipal, OAuth2TokenIntrospectionClaimAccessor

public final class OAuth2IntrospectionAuthenticatedPrincipal
extends Object
implements OAuth2TokenIntrospectionClaimAccessor, OAuth2AuthenticatedPrincipal, Serializable

A domain object that wraps the attributes of OAuth 2.0 Token Introspection.

Since:

5.4

See Also:

• Introspection Response
• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAttributes()	Gets the attributes of the OAuth 2.0 Token Introspection in map form.
Collection<? extends GrantedAuthority>	getAuthorities()	Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 Token Introspection
Map<String,Object>	getClaims()	Returns a set of claims that may be used for assertions.
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.ClaimAccessor

getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, hasClaim

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

getAttribute

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

getAudience, getClientId, getExpiresAt, getId, getIssuedAt, getIssuer, getNotBefore, getScopes, getSubject, getTokenType, getUsername, isActive

Constructor Details

OAuth2IntrospectionAuthenticatedPrincipal

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

Constructs an OAuth2IntrospectionAuthenticatedPrincipal using the provided parameters.

Parameters:

attributes - the attributes of the OAuth 2.0 Token Introspection

authorities - the authorities of the OAuth 2.0 Token Introspection

OAuth2IntrospectionAuthenticatedPrincipal

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

Constructs an OAuth2IntrospectionAuthenticatedPrincipal using the provided parameters.

Parameters:

name - the name attached to the OAuth 2.0 Token Introspection

attributes - the attributes of the OAuth 2.0 Token Introspection

authorities - the authorities of the OAuth 2.0 Token Introspection

Method Details

getAttributes

public Map<String,Object> getAttributes()

Gets the attributes of the OAuth 2.0 Token Introspection 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()

Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 Token Introspection

Specified by:

getAuthorities in interface OAuth2AuthenticatedPrincipal

Returns:

the OAuth 2.0 Token Introspection 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

getClaims

public Map<String,Object> getClaims()

Description copied from interface: ClaimAccessor

Returns a set of claims that may be used for assertions.

Specified by:

getClaims in interface ClaimAccessor

Returns:

a Map of claims