Package org.springframework.security.oauth2.server.authorization.authentication

Class OAuth2AuthorizationConsentAuthenticationProvider

java.lang.Object

org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationConsentAuthenticationProvider

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

public final class OAuth2AuthorizationConsentAuthenticationProvider
extends Object
implements org.springframework.security.authentication.AuthenticationProvider

An AuthenticationProvider implementation for the OAuth 2.0 Authorization Consent used in the Authorization Code Grant.

Since:

0.4.0

See Also:

• OAuth2AuthorizationConsentAuthenticationToken
• OAuth2AuthorizationConsent
• OAuth2AuthorizationCodeRequestAuthenticationProvider
• RegisteredClientRepository
• OAuth2AuthorizationService
• OAuth2AuthorizationConsentService

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthorizationConsentAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService, OAuth2AuthorizationConsentService authorizationConsentService)	Constructs an OAuth2AuthorizationConsentAuthenticationProvider using the provided parameters.

Method Summary

Modifier and Type	Method	Description
org.springframework.security.core.Authentication	authenticate(org.springframework.security.core.Authentication authentication)
void	setAuthorizationCodeGenerator(OAuth2TokenGenerator<OAuth2AuthorizationCode> authorizationCodeGenerator)	Sets the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode.
void	setAuthorizationConsentCustomizer(Consumer<OAuth2AuthorizationConsentAuthenticationContext> authorizationConsentCustomizer)	Sets the Consumer providing access to the OAuth2AuthorizationConsentAuthenticationContext containing an OAuth2AuthorizationConsent.Builder and additional context information.
boolean	supports(Class<?> authentication)

Methods inherited from class java.lang.Object

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

Constructor Details

OAuth2AuthorizationConsentAuthenticationProvider

public OAuth2AuthorizationConsentAuthenticationProvider(RegisteredClientRepository registeredClientRepository,
 OAuth2AuthorizationService authorizationService,
 OAuth2AuthorizationConsentService authorizationConsentService)

Constructs an OAuth2AuthorizationConsentAuthenticationProvider using the provided parameters.

Parameters:

registeredClientRepository - the repository of registered clients

authorizationService - the authorization service

authorizationConsentService - the authorization consent service

Method Details

authenticate

public org.springframework.security.core.Authentication authenticate(org.springframework.security.core.Authentication authentication)
                                                              throws org.springframework.security.core.AuthenticationException

Specified by:

authenticate in interface org.springframework.security.authentication.AuthenticationProvider

Throws:

org.springframework.security.core.AuthenticationException

supports

public boolean supports(Class<?> authentication)

Specified by:

supports in interface org.springframework.security.authentication.AuthenticationProvider

setAuthorizationCodeGenerator

public void setAuthorizationCodeGenerator(OAuth2TokenGenerator<OAuth2AuthorizationCode> authorizationCodeGenerator)

Sets the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode.

Parameters:

authorizationCodeGenerator - the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode

setAuthorizationConsentCustomizer

public void setAuthorizationConsentCustomizer(Consumer<OAuth2AuthorizationConsentAuthenticationContext> authorizationConsentCustomizer)

Sets the Consumer providing access to the OAuth2AuthorizationConsentAuthenticationContext containing an OAuth2AuthorizationConsent.Builder and additional context information.

The following context attributes are available:

• The OAuth2AuthorizationConsent.Builder used to build the authorization consent prior to OAuth2AuthorizationConsentService.save(OAuth2AuthorizationConsent).
• The Authentication of type OAuth2AuthorizationConsentAuthenticationToken.
• The RegisteredClient associated with the authorization request.
• The OAuth2Authorization associated with the state token presented in the authorization consent request.
• The OAuth2AuthorizationRequest associated with the authorization consent request.

Parameters:

authorizationConsentCustomizer - the Consumer providing access to the OAuth2AuthorizationConsentAuthenticationContext containing an OAuth2AuthorizationConsent.Builder