org.springframework.security.oauth2.client.authentication

Class AuthorizationCodeAuthenticationProvider

java.lang.Object

org.springframework.security.oauth2.client.authentication.AuthorizationCodeAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public class AuthorizationCodeAuthenticationProvider
extends java.lang.Object
implements AuthenticationProvider

An implementation of an AuthenticationProvider that 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 and optionally an id token credential (for OpenID Connect Authorization Code Flow).

The AuthorizationCodeAuthenticationProvider uses an AuthorizationGrantAuthenticator to authenticate the authorization code credential and ultimately return an "Authorized Client" as an OAuth2ClientAuthenticationToken.

Since:

5.0

See Also:

AuthorizationCodeAuthenticationToken, OAuth2ClientAuthenticationToken, OidcClientAuthenticationToken, AuthorizationGrantAuthenticator, SecurityTokenRepository, Section 4.1 Authorization Code Grant Flow, Section 3.1 OpenID Connect Authorization Code Flow, Section 4.1.3 Access Token Request, Section 4.1.4 Access Token Response, Section 3.1.3.3 OpenID Connect Token Response

Constructor Summary

Constructors

Constructor and Description
AuthorizationCodeAuthenticationProvider(AuthorizationGrantAuthenticator<AuthorizationCodeAuthenticationToken> authorizationCodeAuthenticator)

Method Summary

Modifier and Type	Method and Description
Authentication	authenticate(Authentication authentication) Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .
void	setAccessTokenRepository(SecurityTokenRepository<AccessToken> accessTokenRepository)
boolean	supports(java.lang.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 Detail

AuthorizationCodeAuthenticationProvider

public AuthorizationCodeAuthenticationProvider(AuthorizationGrantAuthenticator<AuthorizationCodeAuthenticationToken> authorizationCodeAuthenticator)

Method Detail

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.

setAccessTokenRepository

public final void setAccessTokenRepository(SecurityTokenRepository<AccessToken> accessTokenRepository)

supports

public boolean supports(java.lang.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