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.
-
Constructor Summary
ConstructorDescriptionOAuth2AuthorizationCodeAuthenticationProvider
(OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient) Constructs anOAuth2AuthorizationCodeAuthenticationProvider
using the provided parameters. -
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(Authentication authentication) Performs authentication with the same contract asAuthenticationManager.authenticate(Authentication)
.boolean
Returnstrue
if thisAuthenticationProvider
supports the indicatedAuthentication
object.
-
Constructor Details
-
OAuth2AuthorizationCodeAuthenticationProvider
public OAuth2AuthorizationCodeAuthenticationProvider(OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient) Constructs anOAuth2AuthorizationCodeAuthenticationProvider
using the provided parameters.- Parameters:
accessTokenResponseClient
- the client used for requesting the access token credential from the Token Endpoint
-
-
Method Details
-
authenticate
Description copied from interface:AuthenticationProvider
Performs authentication with the same contract asAuthenticationManager.authenticate(Authentication)
.- Specified by:
authenticate
in interfaceAuthenticationProvider
- Parameters:
authentication
- the authentication request object.- Returns:
- a fully authenticated object including credentials. May return
null
if theAuthenticationProvider
is unable to support authentication of the passedAuthentication
object. In such a case, the nextAuthenticationProvider
that supports the presentedAuthentication
class will be tried. - Throws:
AuthenticationException
- if authentication fails.
-
supports
Description copied from interface:AuthenticationProvider
Returnstrue
if thisAuthenticationProvider
supports the indicatedAuthentication
object.Returning
true
does not guarantee anAuthenticationProvider
will be able to authenticate the presented instance of theAuthentication
class. It simply indicates it can support closer evaluation of it. AnAuthenticationProvider
can still returnnull
from theAuthenticationProvider.authenticate(Authentication)
method to indicate anotherAuthenticationProvider
should be tried.Selection of an
AuthenticationProvider
capable of performing authentication is conducted at runtime theProviderManager
.- Specified by:
supports
in interfaceAuthenticationProvider
- Returns:
true
if the implementation can more closely evaluate theAuthentication
class presented
-