Class AbstractOAuth2TokenAuthenticationToken<T extends OAuth2Token>
java.lang.Object
org.springframework.security.authentication.AbstractAuthenticationToken
org.springframework.security.oauth2.server.resource.authentication.AbstractOAuth2TokenAuthenticationToken<T>
- All Implemented Interfaces:
Serializable
,Principal
,Authentication
,CredentialsContainer
- Direct Known Subclasses:
BearerTokenAuthentication
,JwtAuthenticationToken
public abstract class AbstractOAuth2TokenAuthenticationToken<T extends OAuth2Token>
extends AbstractAuthenticationToken
Base class for
AbstractAuthenticationToken
implementations that expose common
attributes between different OAuth 2.0 Access Token Formats.
For example, a Jwt
could expose its claims
via
getTokenAttributes()
or an "Introspected" OAuth 2.0 Access Token
could expose the attributes of the Introspection Response via
getTokenAttributes()
.
- Since:
- 5.1
- See Also:
-
Constructor Summary
ModifierConstructorDescriptionprotected
Sub-class constructor.protected
AbstractOAuth2TokenAuthenticationToken
(T token, Object principal, Object credentials, Collection<? extends GrantedAuthority> authorities) protected
AbstractOAuth2TokenAuthenticationToken
(T token, Collection<? extends GrantedAuthority> authorities) Sub-class constructor. -
Method Summary
Modifier and TypeMethodDescriptionThe credentials that prove the principal is correct.The identity of the principal being authenticated.final T
getToken()
Get the token bound to thisAuthentication
.Returns the attributes of the access token.Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString
-
Constructor Details
-
AbstractOAuth2TokenAuthenticationToken
Sub-class constructor. -
AbstractOAuth2TokenAuthenticationToken
protected AbstractOAuth2TokenAuthenticationToken(T token, Collection<? extends GrantedAuthority> authorities) Sub-class constructor.- Parameters:
authorities
- the authorities assigned to the Access Token
-
AbstractOAuth2TokenAuthenticationToken
protected AbstractOAuth2TokenAuthenticationToken(T token, Object principal, Object credentials, Collection<? extends GrantedAuthority> authorities)
-
-
Method Details
-
getPrincipal
Description copied from interface:Authentication
The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a
UserDetails
object as the principal.- Returns:
- the
Principal
being authenticated or the authenticated principal after authentication.
-
getCredentials
Description copied from interface:Authentication
The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to theAuthenticationManager
. Callers are expected to populate the credentials.- Returns:
- the credentials that prove the identity of the
Principal
-
getToken
Get the token bound to thisAuthentication
. -
getTokenAttributes
Returns the attributes of the access token.- Returns:
- a
Map
of the attributes in the access token.
-