Package org.springframework.security.oauth2.client.authentication

Class OAuth2AuthorizationCodeAuthenticationToken

java.lang.Object
org.springframework.security.authentication.AbstractAuthenticationToken
org.springframework.security.oauth2.client.authentication.OAuth2AuthorizationCodeAuthenticationToken
All Implemented Interfaces:
Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer
public class OAuth2AuthorizationCodeAuthenticationToken extends org.springframework.security.authentication.AbstractAuthenticationToken
An AbstractAuthenticationToken for the OAuth 2.0 Authorization Code Grant.
Since:
5.1
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

    org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

    Nested classes/interfaces inherited from interface org.springframework.security.core.Authentication

    org.springframework.security.core.Authentication.Builder<B extends org.springframework.security.core.Authentication.Builder<B>>

  • Constructor Summary

    Constructors
    Constructor
    Description
    OAuth2AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange authorizationExchange)
    This constructor should be used when the Authorization Request/Response is complete.
    OAuth2AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange authorizationExchange, org.springframework.security.oauth2.core.OAuth2AccessToken accessToken)
    This constructor should be used when the Access Token Request/Response is complete, which indicates that the Authorization Code Grant flow has fully completed.
    OAuth2AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange authorizationExchange, org.springframework.security.oauth2.core.OAuth2AccessToken accessToken, org.springframework.security.oauth2.core.OAuth2RefreshToken refreshToken)
    This constructor should be used when the Access Token Request/Response is complete, which indicates that the Authorization Code Grant flow has fully completed.
    OAuth2AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange authorizationExchange, org.springframework.security.oauth2.core.OAuth2AccessToken accessToken, org.springframework.security.oauth2.core.OAuth2RefreshToken refreshToken, Map<String,Object> additionalParameters)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.security.oauth2.core.OAuth2AccessToken
    getAccessToken()
    Returns the access token.
    Map<String,Object>
    getAdditionalParameters()
    Returns the additional parameters
    org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange
    getAuthorizationExchange()
    Returns the authorization exchange.
    ClientRegistration
    getClientRegistration()
    Returns the client registration.
    Object
    getCredentials()
     
    Object
    getPrincipal()
     
    org.springframework.security.oauth2.core.OAuth2RefreshToken
    getRefreshToken()
    Returns the refresh token.

    Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

    equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.springframework.security.core.Authentication

    toBuilder

    Methods inherited from interface java.security.Principal

    implies

  • Constructor Details

    • OAuth2AuthorizationCodeAuthenticationToken

      public OAuth2AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange authorizationExchange)
      This constructor should be used when the Authorization Request/Response is complete.
      Parameters:
      clientRegistration - the client registration
      authorizationExchange - the authorization exchange

    • OAuth2AuthorizationCodeAuthenticationToken

      public OAuth2AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange authorizationExchange, org.springframework.security.oauth2.core.OAuth2AccessToken accessToken)
      This constructor should be used when the Access Token Request/Response is complete, which indicates that the Authorization Code Grant flow has fully completed.
      Parameters:
      clientRegistration - the client registration
      authorizationExchange - the authorization exchange
      accessToken - the access token credential

    • OAuth2AuthorizationCodeAuthenticationToken

      public OAuth2AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange authorizationExchange, org.springframework.security.oauth2.core.OAuth2AccessToken accessToken, @Nullable org.springframework.security.oauth2.core.OAuth2RefreshToken refreshToken)
      This constructor should be used when the Access Token Request/Response is complete, which indicates that the Authorization Code Grant flow has fully completed.
      Parameters:
      clientRegistration - the client registration
      authorizationExchange - the authorization exchange
      accessToken - the access token credential
      refreshToken - the refresh token credential

    • OAuth2AuthorizationCodeAuthenticationToken

      public OAuth2AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange authorizationExchange, org.springframework.security.oauth2.core.OAuth2AccessToken accessToken, org.springframework.security.oauth2.core.OAuth2RefreshToken refreshToken, Map<String,Object> additionalParameters)

  • Method Details

    • getPrincipal

      public Object getPrincipal()

    • getCredentials

      public Object getCredentials()

    • getClientRegistration

      public ClientRegistration getClientRegistration()
      Returns the client registration.
      Returns:
      the ClientRegistration

    • getAuthorizationExchange

      public org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange getAuthorizationExchange()
      Returns the authorization exchange.
      Returns:
      the OAuth2AuthorizationExchange

    • getAccessToken

      public org.springframework.security.oauth2.core.OAuth2AccessToken getAccessToken()
      Returns the access token.
      Returns:
      the OAuth2AccessToken

    • getRefreshToken

      @Nullable public org.springframework.security.oauth2.core.OAuth2RefreshToken getRefreshToken()
      Returns the refresh token.
      Returns:
      the OAuth2RefreshToken

    • getAdditionalParameters

      public Map<String,Object> getAdditionalParameters()
      Returns the additional parameters
      Returns:
      the additional parameters