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

Class OAuth2PushedAuthorizationRequestAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

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

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

Since:

1.5

See Also:

• OAuth2PushedAuthorizationRequestAuthenticationToken
• OAuth2AuthorizationCodeRequestAuthenticationToken
• OAuth2AuthorizationCodeRequestAuthenticationValidator
• OAuth2AuthorizationService
• Section 2.1 Pushed Authorization Request
• Section 2.2 Pushed Authorization Response

Constructor Summary

Constructors

Constructor	Description
OAuth2PushedAuthorizationRequestAuthenticationProvider(OAuth2AuthorizationService authorizationService)	Constructs an OAuth2PushedAuthorizationRequestAuthenticationProvider using the provided parameters.

Method Summary

Modifier and Type	Method	Description
org.springframework.security.core.Authentication	authenticate(org.springframework.security.core.Authentication authentication)
void	setAuthenticationValidator(Consumer<OAuth2AuthorizationCodeRequestAuthenticationContext> authenticationValidator)	Sets the Consumer providing access to the OAuth2AuthorizationCodeRequestAuthenticationContext and is responsible for validating specific OAuth 2.0 Pushed Authorization Request parameters associated in the OAuth2AuthorizationCodeRequestAuthenticationToken.
boolean	supports(Class<?> authentication)

Methods inherited from class java.lang.Object

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

Constructor Details

OAuth2PushedAuthorizationRequestAuthenticationProvider

public OAuth2PushedAuthorizationRequestAuthenticationProvider(OAuth2AuthorizationService authorizationService)

Constructs an OAuth2PushedAuthorizationRequestAuthenticationProvider using the provided parameters.

Parameters:

authorizationService - the authorization 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

setAuthenticationValidator

public void setAuthenticationValidator(Consumer<OAuth2AuthorizationCodeRequestAuthenticationContext> authenticationValidator)

Sets the Consumer providing access to the OAuth2AuthorizationCodeRequestAuthenticationContext and is responsible for validating specific OAuth 2.0 Pushed Authorization Request parameters associated in the OAuth2AuthorizationCodeRequestAuthenticationToken. The default authentication validator is OAuth2AuthorizationCodeRequestAuthenticationValidator.

NOTE: The authentication validator MUST throw OAuth2AuthorizationCodeRequestAuthenticationException if validation fails.

Parameters:

authenticationValidator - the Consumer providing access to the OAuth2AuthorizationCodeRequestAuthenticationContext and is responsible for validating specific OAuth 2.0 Pushed Authorization Request parameters