org.springframework.security.oauth2.client

Class DelegatingOAuth2AuthorizedClientProvider

java.lang.Object

org.springframework.security.oauth2.client.DelegatingOAuth2AuthorizedClientProvider

All Implemented Interfaces:

OAuth2AuthorizedClientProvider

public final class DelegatingOAuth2AuthorizedClientProvider
extends java.lang.Object
implements OAuth2AuthorizedClientProvider

An implementation of an OAuth2AuthorizedClientProvider that simply delegates to it's internal List of OAuth2AuthorizedClientProvider(s).

Each provider is given a chance to authorize the client in the provided context with the first non-null OAuth2AuthorizedClient being returned.

Since:

5.2

See Also:

OAuth2AuthorizedClientProvider

Constructor Summary

Constructors

Constructor and Description
DelegatingOAuth2AuthorizedClientProvider(java.util.List<OAuth2AuthorizedClientProvider> authorizedClientProviders) Constructs a DelegatingOAuth2AuthorizedClientProvider using the provided parameters.
DelegatingOAuth2AuthorizedClientProvider(OAuth2AuthorizedClientProvider... authorizedClientProviders) Constructs a DelegatingOAuth2AuthorizedClientProvider using the provided parameters.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingOAuth2AuthorizedClientProvider

public DelegatingOAuth2AuthorizedClientProvider(OAuth2AuthorizedClientProvider... authorizedClientProviders)

Constructs a DelegatingOAuth2AuthorizedClientProvider using the provided parameters.

Parameters:

authorizedClientProviders - a list of OAuth2AuthorizedClientProvider(s)

DelegatingOAuth2AuthorizedClientProvider

public DelegatingOAuth2AuthorizedClientProvider(java.util.List<OAuth2AuthorizedClientProvider> authorizedClientProviders)

Constructs a DelegatingOAuth2AuthorizedClientProvider using the provided parameters.

Parameters:

authorizedClientProviders - a List of OAuth2AuthorizedClientProvider(s)

Method Detail

authorize

@Nullable
public OAuth2AuthorizedClient authorize(OAuth2AuthorizationContext context)

Description copied from interface: OAuth2AuthorizedClientProvider

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.

Specified by:

authorize in interface OAuth2AuthorizedClientProvider

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