Interface OAuth2TokenContext

All Superinterfaces:
Context
All Known Implementing Classes:
DefaultOAuth2TokenContext, JwtEncodingContext, OAuth2TokenClaimsContext
public interface OAuth2TokenContext extends Context
A context that holds information (to be) associated to an OAuth 2.0 Token and is used by an OAuth2TokenGenerator and OAuth2TokenCustomizer.
Since:
7.0
See Also:

  • Field Details

    • DPOP_PROOF_KEY

      static final String DPOP_PROOF_KEY
      The key used for the DPoP Proof Jwt (if available).

  • Method Details

    • getRegisteredClient

      default RegisteredClient getRegisteredClient()
      Returns the registered client.
      Returns:
      the RegisteredClient

    • getPrincipal

      default <T extends org.springframework.security.core.Authentication> @Nullable T getPrincipal()
      Returns the Authentication representing the Principal resource owner (or client).
      Type Parameters:
      T - the type of the Authentication
      Returns:
      the Authentication representing the Principal resource owner (or client), or null if not available

    • getAuthorizationServerContext

      default AuthorizationServerContext getAuthorizationServerContext()
      Returns the authorization server context.
      Returns:
      the AuthorizationServerContext

    • getAuthorization

      default @Nullable OAuth2Authorization getAuthorization()
      Returns the authorization.
      Returns:
      the OAuth2Authorization, or null if not available

    • getAuthorizedScopes

      default Set<String> getAuthorizedScopes()
      Returns the authorized scope(s).
      Returns:
      the authorized scope(s)

    • getTokenType

      default OAuth2TokenType getTokenType()
      Returns the token type.
      Returns:
      the OAuth2TokenType

    • getAuthorizationGrantType

      default @Nullable org.springframework.security.oauth2.core.AuthorizationGrantType getAuthorizationGrantType()
      Returns the authorization grant type.
      Returns:
      the AuthorizationGrantType, or null if not available

    • getAuthorizationGrant

      default <T extends org.springframework.security.core.Authentication> @Nullable T getAuthorizationGrant()
      Returns the Authentication representing the authorization grant.
      Type Parameters:
      T - the type of the Authentication
      Returns:
      the Authentication representing the authorization grant, or null if not available