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

Class OAuth2ClientCredentialsAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

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

An AuthenticationProvider implementation for the OAuth 2.0 Client Credentials Grant.

Since:

0.0.1

See Also:

• OAuth2ClientCredentialsAuthenticationToken
• OAuth2AccessTokenAuthenticationToken
• OAuth2AuthorizationService
• OAuth2TokenGenerator
• Section 4.4 Client Credentials Grant
• Section 4.4.2 Access Token Request

Constructor Summary

Constructors

Constructor	Description
OAuth2ClientCredentialsAuthenticationProvider(OAuth2AuthorizationService authorizationService, OAuth2TokenGenerator<? extends org.springframework.security.oauth2.core.OAuth2Token> tokenGenerator)	Constructs an OAuth2ClientCredentialsAuthenticationProvider 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<OAuth2ClientCredentialsAuthenticationContext> authenticationValidator)	Sets the Consumer providing access to the OAuth2ClientCredentialsAuthenticationContext and is responsible for validating specific OAuth 2.0 Client Credentials Grant Request parameters associated in the OAuth2ClientCredentialsAuthenticationToken.
boolean	supports(Class<?> authentication)

Methods inherited from class java.lang.Object

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

Constructor Details

OAuth2ClientCredentialsAuthenticationProvider

public OAuth2ClientCredentialsAuthenticationProvider(OAuth2AuthorizationService authorizationService,
 OAuth2TokenGenerator<? extends org.springframework.security.oauth2.core.OAuth2Token> tokenGenerator)

Constructs an OAuth2ClientCredentialsAuthenticationProvider using the provided parameters.

Parameters:

authorizationService - the authorization service

tokenGenerator - the token generator

Since:

0.2.3

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<OAuth2ClientCredentialsAuthenticationContext> authenticationValidator)

Sets the Consumer providing access to the OAuth2ClientCredentialsAuthenticationContext and is responsible for validating specific OAuth 2.0 Client Credentials Grant Request parameters associated in the OAuth2ClientCredentialsAuthenticationToken. The default authentication validator is OAuth2ClientCredentialsAuthenticationValidator.

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

Parameters:

authenticationValidator - the Consumer providing access to the OAuth2ClientCredentialsAuthenticationContext and is responsible for validating specific OAuth 2.0 Client Credentials Grant Request parameters

Since:

1.3