Class OAuth2AuthorizationCodeAuthenticationProvider

All Implemented Interfaces:

public class OAuth2AuthorizationCodeAuthenticationProvider extends Object implements AuthenticationProvider
An implementation of an AuthenticationProvider for the OAuth 2.0 Authorization Code Grant.

This AuthenticationProvider is responsible for authenticating an Authorization Code credential with the Authorization Server's Token Endpoint and if valid, exchanging it for an Access Token credential.

See Also:
  • Constructor Details

    • OAuth2AuthorizationCodeAuthenticationProvider

      public OAuth2AuthorizationCodeAuthenticationProvider(OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient)
      Constructs an OAuth2AuthorizationCodeAuthenticationProvider using the provided parameters.
      accessTokenResponseClient - the client used for requesting the access token credential from the Token Endpoint
  • Method Details

    • authenticate

      public Authentication authenticate(Authentication authentication) throws AuthenticationException
      Description copied from interface: AuthenticationProvider
      Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .
      Specified by:
      authenticate in interface AuthenticationProvider
      authentication - the authentication request object.
      a fully authenticated object including credentials. May return null if the AuthenticationProvider is unable to support authentication of the passed Authentication object. In such a case, the next AuthenticationProvider that supports the presented Authentication class will be tried.
      AuthenticationException - if authentication fails.
    • supports

      public boolean supports(Class<?> authentication)
      Description copied from interface: AuthenticationProvider
      Returns true if this AuthenticationProvider supports the indicated Authentication object.

      Returning true does not guarantee an AuthenticationProvider will be able to authenticate the presented instance of the Authentication class. It simply indicates it can support closer evaluation of it. An AuthenticationProvider can still return null from the AuthenticationProvider.authenticate(Authentication) method to indicate another AuthenticationProvider should be tried.

      Selection of an AuthenticationProvider capable of performing authentication is conducted at runtime the ProviderManager.

      Specified by:
      supports in interface AuthenticationProvider
      true if the implementation can more closely evaluate the Authentication class presented