Package org.springframework.security.oauth2.client

Interface OAuth2AuthorizedClientProvider

All Known Implementing Classes:

AuthorizationCodeOAuth2AuthorizedClientProvider, ClientCredentialsOAuth2AuthorizedClientProvider, DelegatingOAuth2AuthorizedClientProvider, JwtBearerOAuth2AuthorizedClientProvider, PasswordOAuth2AuthorizedClientProvider, RefreshTokenOAuth2AuthorizedClientProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface OAuth2AuthorizedClientProvider

A strategy for authorizing (or re-authorizing) an OAuth 2.0 Client. Implementations will typically implement a specific authorization grant type.

Since:

5.2

See Also:

• OAuth2AuthorizedClient
• OAuth2AuthorizationContext
• Section 1.3 Authorization Grant

Method Summary

Modifier and Type	Method	Description
OAuth2AuthorizedClient	authorize(OAuth2AuthorizationContext context)	Attempt to authorize (or re-authorize) the client in the provided context.

Method Details

authorize

@Nullable
OAuth2AuthorizedClient authorize(OAuth2AuthorizationContext context)

Attempt to authorize (or re-authorize) the client in the provided context. Implementations must return null if authorization is not supported for the specified client, e.g. the provider doesn't support the authorization grant type configured for the client.

Parameters:

context - the context that holds authorization-specific state for the client

Returns:

the OAuth2AuthorizedClient or null if authorization is not supported for the specified client