Class OAuth2TokenIntrospectionAuthenticationToken

java.lang.Object
org.springframework.security.authentication.AbstractAuthenticationToken
org.springframework.security.oauth2.server.authorization.authentication.OAuth2TokenIntrospectionAuthenticationToken
All Implemented Interfaces:
Serializable, Principal, Authentication, CredentialsContainer
public class OAuth2TokenIntrospectionAuthenticationToken extends AbstractAuthenticationToken
An Authentication implementation used for OAuth 2.0 Token Introspection.
Since:
7.0
See Also:

  • Constructor Details

    • OAuth2TokenIntrospectionAuthenticationToken

      public OAuth2TokenIntrospectionAuthenticationToken(String token, Authentication clientPrincipal, @Nullable String tokenTypeHint, @Nullable Map<String,Object> additionalParameters)
      Constructs an OAuth2TokenIntrospectionAuthenticationToken using the provided parameters.
      Parameters:
      token - the token
      clientPrincipal - the authenticated client principal
      tokenTypeHint - the token type hint
      additionalParameters - the additional parameters

    • OAuth2TokenIntrospectionAuthenticationToken

      public OAuth2TokenIntrospectionAuthenticationToken(String token, Authentication clientPrincipal, OAuth2TokenIntrospection tokenClaims)
      Constructs an OAuth2TokenIntrospectionAuthenticationToken using the provided parameters.
      Parameters:
      token - the token
      clientPrincipal - the authenticated client principal
      tokenClaims - the token claims

  • Method Details

    • getPrincipal

      public Object 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

      public Object 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 the AuthenticationManager. Callers are expected to populate the credentials.
      Returns:
      the credentials that prove the identity of the Principal

    • getToken

      public String getToken()
      Returns the token.
      Returns:
      the token

    • getTokenTypeHint

      public @Nullable String getTokenTypeHint()
      Returns the token type hint.
      Returns:
      the token type hint

    • getAdditionalParameters

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

    • getTokenClaims

      public OAuth2TokenIntrospection getTokenClaims()
      Returns the token claims.
      Returns:
      the OAuth2TokenIntrospection