Package org.springframework.security.oauth2.client.web.server

Class AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository

java.lang.Object

org.springframework.security.oauth2.client.web.server.AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository

All Implemented Interfaces:

ServerOAuth2AuthorizedClientRepository

public final class AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository
extends java.lang.Object
implements ServerOAuth2AuthorizedClientRepository

An implementation of an ServerOAuth2AuthorizedClientRepository that delegates to the provided ServerOAuth2AuthorizedClientRepository if the current Principal is authenticated, otherwise, to the default (or provided) ServerOAuth2AuthorizedClientRepository if the current request is unauthenticated (or anonymous). The default ReactiveOAuth2AuthorizedClientRepository is WebSessionServerOAuth2AuthorizedClientRepository.

Since:

5.1

See Also:

OAuth2AuthorizedClientRepository, OAuth2AuthorizedClient, OAuth2AuthorizedClientService, HttpSessionOAuth2AuthorizedClientRepository

Constructor Summary

Constructors

Constructor	Description
AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository(ReactiveOAuth2AuthorizedClientService authorizedClientService)	Creates an instance

Method Summary

Modifier and Type	Method	Description
<T extends OAuth2AuthorizedClient> reactor.core.publisher.Mono<T>	loadAuthorizedClient(java.lang.String clientRegistrationId, org.springframework.security.core.Authentication principal, org.springframework.web.server.ServerWebExchange exchange)	Returns the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User Authentication (Resource Owner) or null if not available.
reactor.core.publisher.Mono<java.lang.Void>	removeAuthorizedClient(java.lang.String clientRegistrationId, org.springframework.security.core.Authentication principal, org.springframework.web.server.ServerWebExchange exchange)	Removes the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User Authentication (Resource Owner).
reactor.core.publisher.Mono<java.lang.Void>	saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient, org.springframework.security.core.Authentication principal, org.springframework.web.server.ServerWebExchange exchange)	Saves the OAuth2AuthorizedClient associating it to the provided End-User Authentication (Resource Owner).
void	setAnonymousAuthorizedClientRepository(ServerOAuth2AuthorizedClientRepository anonymousAuthorizedClientRepository)	Sets the ServerOAuth2AuthorizedClientRepository used for requests that are unauthenticated (or anonymous).

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository

public AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository(ReactiveOAuth2AuthorizedClientService authorizedClientService)

Creates an instance

Parameters:

authorizedClientService - the authorized client service

Method Detail

setAnonymousAuthorizedClientRepository

public void setAnonymousAuthorizedClientRepository(ServerOAuth2AuthorizedClientRepository anonymousAuthorizedClientRepository)

Sets the ServerOAuth2AuthorizedClientRepository used for requests that are unauthenticated (or anonymous). The default is WebSessionServerOAuth2AuthorizedClientRepository.

Parameters:

anonymousAuthorizedClientRepository - the repository used for requests that are unauthenticated (or anonymous)

loadAuthorizedClient

public <T extends OAuth2AuthorizedClient> reactor.core.publisher.Mono<T> loadAuthorizedClient(java.lang.String clientRegistrationId,
                                                                                              org.springframework.security.core.Authentication principal,
                                                                                              org.springframework.web.server.ServerWebExchange exchange)

Description copied from interface: ServerOAuth2AuthorizedClientRepository

Returns the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User Authentication (Resource Owner) or null if not available.

Specified by:

loadAuthorizedClient in interface ServerOAuth2AuthorizedClientRepository

Type Parameters:

T - a type of OAuth2AuthorizedClient

Parameters:

clientRegistrationId - the identifier for the client's registration

principal - the End-User Authentication (Resource Owner)

exchange - the ServerWebExchange

Returns:

the OAuth2AuthorizedClient or null if not available

saveAuthorizedClient

public reactor.core.publisher.Mono<java.lang.Void> saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient,
                                                                        org.springframework.security.core.Authentication principal,
                                                                        org.springframework.web.server.ServerWebExchange exchange)

Description copied from interface: ServerOAuth2AuthorizedClientRepository

Saves the OAuth2AuthorizedClient associating it to the provided End-User Authentication (Resource Owner).

Specified by:

saveAuthorizedClient in interface ServerOAuth2AuthorizedClientRepository

Parameters:

authorizedClient - the authorized client

principal - the End-User Authentication (Resource Owner)

exchange - the ServerWebExchange

removeAuthorizedClient

public reactor.core.publisher.Mono<java.lang.Void> removeAuthorizedClient(java.lang.String clientRegistrationId,
                                                                          org.springframework.security.core.Authentication principal,
                                                                          org.springframework.web.server.ServerWebExchange exchange)

Description copied from interface: ServerOAuth2AuthorizedClientRepository

Removes the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User Authentication (Resource Owner).

Specified by:

removeAuthorizedClient in interface ServerOAuth2AuthorizedClientRepository

Parameters:

clientRegistrationId - the identifier for the client's registration

principal - the End-User Authentication (Resource Owner)

exchange - the ServerWebExchange