Package org.springframework.security.oauth2.client

Class R2dbcReactiveOAuth2AuthorizedClientService

java.lang.Object

org.springframework.security.oauth2.client.R2dbcReactiveOAuth2AuthorizedClientService

All Implemented Interfaces:

ReactiveOAuth2AuthorizedClientService

public class R2dbcReactiveOAuth2AuthorizedClientService
extends Object
implements ReactiveOAuth2AuthorizedClientService

A R2DBC implementation of ReactiveOAuth2AuthorizedClientService that uses a DatabaseClient for OAuth2AuthorizedClient persistence.

NOTE: This ReactiveOAuth2AuthorizedClientService depends on the table definition described in "classpath:org/springframework/security/oauth2/client/oauth2-client-schema.sql" and therefore MUST be defined in the database schema.

Since:

5.5

See Also:

• ReactiveOAuth2AuthorizedClientService
• OAuth2AuthorizedClient
• DatabaseClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder	A holder for OAuth2AuthorizedClient data and End-User Authentication (Resource Owner).
static class	R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientParametersMapper	The default Function that maps R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder to a Map of String and Parameter.
static class	R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientRowMapper	The default BiFunction that maps the current io.r2dbc.spi.Row to a R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder.

Field Summary

Fields

Modifier and Type	Field	Description
protected Function<R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder,Map<String,org.springframework.r2dbc.core.Parameter>>	authorizedClientParametersMapper
protected BiFunction<io.r2dbc.spi.Row,io.r2dbc.spi.RowMetadata,R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder>	authorizedClientRowMapper
protected final ReactiveClientRegistrationRepository	clientRegistrationRepository
protected final org.springframework.r2dbc.core.DatabaseClient	databaseClient

Constructor Summary

Constructors

Constructor	Description
R2dbcReactiveOAuth2AuthorizedClientService(org.springframework.r2dbc.core.DatabaseClient databaseClient, ReactiveClientRegistrationRepository clientRegistrationRepository)	Constructs a R2dbcReactiveOAuth2AuthorizedClientService using the provided parameters.

Method Summary

Modifier and Type	Method	Description
<T extends OAuth2AuthorizedClient> reactor.core.publisher.Mono<T>	loadAuthorizedClient(String clientRegistrationId, String principalName)	Returns the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name or null if not available.
reactor.core.publisher.Mono<Void>	removeAuthorizedClient(String clientRegistrationId, String principalName)	Removes the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name.
reactor.core.publisher.Mono<Void>	saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient, Authentication principal)	Saves the OAuth2AuthorizedClient associating it to the provided End-User Authentication (Resource Owner).
final void	setAuthorizedClientParametersMapper(Function<R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder,Map<String,org.springframework.r2dbc.core.Parameter>> authorizedClientParametersMapper)	Sets the Function used for mapping R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder to a Map of String and Parameter.
final void	setAuthorizedClientRowMapper(BiFunction<io.r2dbc.spi.Row,io.r2dbc.spi.RowMetadata,R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder> authorizedClientRowMapper)	Sets the BiFunction used for mapping the current io.r2dbc.spi.Row to R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder.

Methods inherited from class java.lang.Object

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

Field Details

databaseClient

protected final org.springframework.r2dbc.core.DatabaseClient databaseClient

clientRegistrationRepository

protected final ReactiveClientRegistrationRepository clientRegistrationRepository

authorizedClientParametersMapper

protected Function<R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder,Map<String,org.springframework.r2dbc.core.Parameter>> authorizedClientParametersMapper

authorizedClientRowMapper

protected BiFunction<io.r2dbc.spi.Row,io.r2dbc.spi.RowMetadata,R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder> authorizedClientRowMapper

Constructor Details

R2dbcReactiveOAuth2AuthorizedClientService

public R2dbcReactiveOAuth2AuthorizedClientService(org.springframework.r2dbc.core.DatabaseClient databaseClient,
 ReactiveClientRegistrationRepository clientRegistrationRepository)

Constructs a R2dbcReactiveOAuth2AuthorizedClientService using the provided parameters.

Parameters:

databaseClient - the database client

clientRegistrationRepository - the repository of client registrations

Method Details

loadAuthorizedClient

public <T extends OAuth2AuthorizedClient>
reactor.core.publisher.Mono<T> loadAuthorizedClient(String clientRegistrationId,
 String principalName)

Description copied from interface: ReactiveOAuth2AuthorizedClientService

Returns the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name or null if not available.

Specified by:

loadAuthorizedClient in interface ReactiveOAuth2AuthorizedClientService

Type Parameters:

T - a type of OAuth2AuthorizedClient

Parameters:

clientRegistrationId - the identifier for the client's registration

principalName - the name of the End-User Principal (Resource Owner)

Returns:

the OAuth2AuthorizedClient or null if not available

saveAuthorizedClient

public reactor.core.publisher.Mono<Void> saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient,
 Authentication principal)

Description copied from interface: ReactiveOAuth2AuthorizedClientService

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

Specified by:

saveAuthorizedClient in interface ReactiveOAuth2AuthorizedClientService

Parameters:

authorizedClient - the authorized client

principal - the End-User Authentication (Resource Owner)

removeAuthorizedClient

public reactor.core.publisher.Mono<Void> removeAuthorizedClient(String clientRegistrationId,
 String principalName)

Description copied from interface: ReactiveOAuth2AuthorizedClientService

Removes the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name.

Specified by:

removeAuthorizedClient in interface ReactiveOAuth2AuthorizedClientService

Parameters:

clientRegistrationId - the identifier for the client's registration

principalName - the name of the End-User Principal (Resource Owner)

setAuthorizedClientParametersMapper

public final void setAuthorizedClientParametersMapper(Function<R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder,Map<String,org.springframework.r2dbc.core.Parameter>> authorizedClientParametersMapper)

Sets the Function used for mapping R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder to a Map of String and Parameter. The default is R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientParametersMapper.

Parameters:

authorizedClientParametersMapper - the Function used for mapping R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder to a Map of String and Parameter

setAuthorizedClientRowMapper

public final void setAuthorizedClientRowMapper(BiFunction<io.r2dbc.spi.Row,io.r2dbc.spi.RowMetadata,R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder> authorizedClientRowMapper)

Sets the BiFunction used for mapping the current io.r2dbc.spi.Row to R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder. The default is R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientRowMapper.

Parameters:

authorizedClientRowMapper - the BiFunction used for mapping the current io.r2dbc.spi.Row to R2dbcReactiveOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder