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

Class OAuth2AuthorizationCodeAuthenticationProvider

java.lang.Object

org.springframework.security.oauth2.client.authentication.OAuth2AuthorizationCodeAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

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.

Since:

5.1

See Also:

• OAuth2AuthorizationCodeAuthenticationToken
• OAuth2AccessTokenResponseClient
• Section 4.1 Authorization Code Grant Flow
• Section 4.1.3 Access Token Request
• Section 4.1.4 Access Token Response

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthorizationCodeAuthenticationProvider(OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient)	Constructs an OAuth2AuthorizationCodeAuthenticationProvider using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Authentication	authenticate(Authentication authentication)	Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .
boolean	supports(Class<?> authentication)	Returns true if this AuthenticationProvider supports the indicated Authentication object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OAuth2AuthorizationCodeAuthenticationProvider

public OAuth2AuthorizationCodeAuthenticationProvider(OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient)

Constructs an OAuth2AuthorizationCodeAuthenticationProvider using the provided parameters.

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

Parameters:

authentication - the authentication request object.

Returns:

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.

Throws:

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

Returns:

true if the implementation can more closely evaluate the Authentication class presented