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

Class UnAuthenticatedServerOAuth2AuthorizedClientRepository

java.lang.Object

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

All Implemented Interfaces:

ServerOAuth2AuthorizedClientRepository

public class UnAuthenticatedServerOAuth2AuthorizedClientRepository
extends java.lang.Object
implements ServerOAuth2AuthorizedClientRepository

Provides support for an unauthenticated user. This is useful when running as a process with no user associated to it. The implementation ensures that ServerWebExchange is null and that the Authentication is either null or anonymous to prevent using it incorrectly.

Since:

5.1

Constructor Summary

Constructors

Constructor and Description
UnAuthenticatedServerOAuth2AuthorizedClientRepository()

Method Summary

Modifier and Type	Method and Description
<T extends OAuth2AuthorizedClient> reactor.core.publisher.Mono<T>	loadAuthorizedClient(java.lang.String clientRegistrationId, org.springframework.security.core.Authentication authentication, org.springframework.web.server.ServerWebExchange serverWebExchange) 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 authentication, org.springframework.web.server.ServerWebExchange serverWebExchange) 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 authentication, org.springframework.web.server.ServerWebExchange serverWebExchange) Saves the OAuth2AuthorizedClient associating it to the provided End-User Authentication (Resource Owner).

Methods inherited from class java.lang.Object

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

Constructor Detail

UnAuthenticatedServerOAuth2AuthorizedClientRepository

public UnAuthenticatedServerOAuth2AuthorizedClientRepository()

Method Detail

loadAuthorizedClient

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

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

authentication - the End-User Authentication (Resource Owner)

serverWebExchange - 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 authentication,
                                                                        org.springframework.web.server.ServerWebExchange serverWebExchange)

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

authentication - the End-User Authentication (Resource Owner)

serverWebExchange - the ServerWebExchange

removeAuthorizedClient

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

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

authentication - the End-User Authentication (Resource Owner)

serverWebExchange - the ServerWebExchange