Class WebSessionServerOAuth2AuthorizedClientRepository
- java.lang.Object
-
- org.springframework.security.oauth2.client.web.server.WebSessionServerOAuth2AuthorizedClientRepository
-
- All Implemented Interfaces:
ServerOAuth2AuthorizedClientRepository
public final class WebSessionServerOAuth2AuthorizedClientRepository extends java.lang.Object implements ServerOAuth2AuthorizedClientRepository
An implementation of anOAuth2AuthorizedClientRepository
that storesOAuth2AuthorizedClient
's in theHttpSession
.- Since:
- 5.1
- See Also:
OAuth2AuthorizedClientRepository
,OAuth2AuthorizedClient
-
-
Constructor Summary
Constructors Constructor Description WebSessionServerOAuth2AuthorizedClientRepository()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T extends OAuth2AuthorizedClient>
reactor.core.publisher.Mono<T>loadAuthorizedClient(java.lang.String clientRegistrationId, Authentication principal, org.springframework.web.server.ServerWebExchange exchange)
Returns theOAuth2AuthorizedClient
associated to the provided client registration identifier and End-UserAuthentication
(Resource Owner) ornull
if not available.reactor.core.publisher.Mono<java.lang.Void>
removeAuthorizedClient(java.lang.String clientRegistrationId, Authentication principal, org.springframework.web.server.ServerWebExchange exchange)
Removes theOAuth2AuthorizedClient
associated to the provided client registration identifier and End-UserAuthentication
(Resource Owner).reactor.core.publisher.Mono<java.lang.Void>
saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient, Authentication principal, org.springframework.web.server.ServerWebExchange exchange)
Saves theOAuth2AuthorizedClient
associating it to the provided End-UserAuthentication
(Resource Owner).
-
-
-
Method Detail
-
loadAuthorizedClient
public <T extends OAuth2AuthorizedClient> reactor.core.publisher.Mono<T> loadAuthorizedClient(java.lang.String clientRegistrationId, Authentication principal, org.springframework.web.server.ServerWebExchange exchange)
Description copied from interface:ServerOAuth2AuthorizedClientRepository
Returns theOAuth2AuthorizedClient
associated to the provided client registration identifier and End-UserAuthentication
(Resource Owner) ornull
if not available.- Specified by:
loadAuthorizedClient
in interfaceServerOAuth2AuthorizedClientRepository
- Type Parameters:
T
- a type of OAuth2AuthorizedClient- Parameters:
clientRegistrationId
- the identifier for the client's registrationprincipal
- the End-UserAuthentication
(Resource Owner)exchange
- theServerWebExchange
- Returns:
- the
OAuth2AuthorizedClient
ornull
if not available
-
saveAuthorizedClient
public reactor.core.publisher.Mono<java.lang.Void> saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient, Authentication principal, org.springframework.web.server.ServerWebExchange exchange)
Description copied from interface:ServerOAuth2AuthorizedClientRepository
Saves theOAuth2AuthorizedClient
associating it to the provided End-UserAuthentication
(Resource Owner).- Specified by:
saveAuthorizedClient
in interfaceServerOAuth2AuthorizedClientRepository
- Parameters:
authorizedClient
- the authorized clientprincipal
- the End-UserAuthentication
(Resource Owner)exchange
- theServerWebExchange
-
removeAuthorizedClient
public reactor.core.publisher.Mono<java.lang.Void> removeAuthorizedClient(java.lang.String clientRegistrationId, Authentication principal, org.springframework.web.server.ServerWebExchange exchange)
Description copied from interface:ServerOAuth2AuthorizedClientRepository
Removes theOAuth2AuthorizedClient
associated to the provided client registration identifier and End-UserAuthentication
(Resource Owner).- Specified by:
removeAuthorizedClient
in interfaceServerOAuth2AuthorizedClientRepository
- Parameters:
clientRegistrationId
- the identifier for the client's registrationprincipal
- the End-UserAuthentication
(Resource Owner)exchange
- theServerWebExchange
-
-