Package org.springframework.security.oauth2.client

Class JdbcOAuth2AuthorizedClientService

java.lang.Object

org.springframework.security.oauth2.client.JdbcOAuth2AuthorizedClientService

All Implemented Interfaces:

OAuth2AuthorizedClientService

public class JdbcOAuth2AuthorizedClientService
extends java.lang.Object
implements OAuth2AuthorizedClientService

A JDBC implementation of an OAuth2AuthorizedClientService that uses a JdbcOperations for OAuth2AuthorizedClient persistence.

NOTE: This OAuth2AuthorizedClientService 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.3

See Also:

OAuth2AuthorizedClientService, OAuth2AuthorizedClient, JdbcOperations, RowMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder	A holder for an OAuth2AuthorizedClient and End-User Authentication (Resource Owner).
static class	JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientParametersMapper	The default Function that maps JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder to a List of SqlParameterValue.
static class	JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientRowMapper	The default RowMapper that maps the current row in java.sql.ResultSet to OAuth2AuthorizedClient.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Function<JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder,java.util.List<org.springframework.jdbc.core.SqlParameterValue>>	authorizedClientParametersMapper
protected org.springframework.jdbc.core.RowMapper<OAuth2AuthorizedClient>	authorizedClientRowMapper
protected org.springframework.jdbc.core.JdbcOperations	jdbcOperations
protected org.springframework.jdbc.support.lob.LobHandler	lobHandler

Constructor Summary

Constructors

Constructor	Description
JdbcOAuth2AuthorizedClientService(org.springframework.jdbc.core.JdbcOperations jdbcOperations, ClientRegistrationRepository clientRegistrationRepository)	Constructs a JdbcOAuth2AuthorizedClientService using the provided parameters.
JdbcOAuth2AuthorizedClientService(org.springframework.jdbc.core.JdbcOperations jdbcOperations, ClientRegistrationRepository clientRegistrationRepository, org.springframework.jdbc.support.lob.LobHandler lobHandler)	Constructs a JdbcOAuth2AuthorizedClientService using the provided parameters.

Method Summary

Modifier and Type	Method	Description
<T extends OAuth2AuthorizedClient> T	loadAuthorizedClient(java.lang.String clientRegistrationId, java.lang.String principalName)	Returns the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name or null if not available.
void	removeAuthorizedClient(java.lang.String clientRegistrationId, java.lang.String principalName)	Removes the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name.
void	saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient, Authentication principal)	Saves the OAuth2AuthorizedClient associating it to the provided End-User Authentication (Resource Owner).
void	setAuthorizedClientParametersMapper(java.util.function.Function<JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder,java.util.List<org.springframework.jdbc.core.SqlParameterValue>> authorizedClientParametersMapper)	Sets the Function used for mapping JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder to a List of SqlParameterValue.
void	setAuthorizedClientRowMapper(org.springframework.jdbc.core.RowMapper<OAuth2AuthorizedClient> authorizedClientRowMapper)	Sets the RowMapper used for mapping the current row in java.sql.ResultSet to OAuth2AuthorizedClient.

Methods inherited from class java.lang.Object

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

Field Detail

jdbcOperations

protected final org.springframework.jdbc.core.JdbcOperations jdbcOperations

authorizedClientRowMapper

protected org.springframework.jdbc.core.RowMapper<OAuth2AuthorizedClient> authorizedClientRowMapper

authorizedClientParametersMapper

protected java.util.function.Function<JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder,java.util.List<org.springframework.jdbc.core.SqlParameterValue>> authorizedClientParametersMapper

lobHandler

protected final org.springframework.jdbc.support.lob.LobHandler lobHandler

Constructor Detail

JdbcOAuth2AuthorizedClientService

public JdbcOAuth2AuthorizedClientService(org.springframework.jdbc.core.JdbcOperations jdbcOperations,
                                         ClientRegistrationRepository clientRegistrationRepository)

Constructs a JdbcOAuth2AuthorizedClientService using the provided parameters.

Parameters:

jdbcOperations - the JDBC operations

clientRegistrationRepository - the repository of client registrations

JdbcOAuth2AuthorizedClientService

public JdbcOAuth2AuthorizedClientService(org.springframework.jdbc.core.JdbcOperations jdbcOperations,
                                         ClientRegistrationRepository clientRegistrationRepository,
                                         org.springframework.jdbc.support.lob.LobHandler lobHandler)

Constructs a JdbcOAuth2AuthorizedClientService using the provided parameters.

Parameters:

jdbcOperations - the JDBC operations

clientRegistrationRepository - the repository of client registrations

lobHandler - the handler for large binary fields and large text fields

Since:

5.5

Method Detail

loadAuthorizedClient

public <T extends OAuth2AuthorizedClient> T loadAuthorizedClient(java.lang.String clientRegistrationId,
                                                                 java.lang.String principalName)

Description copied from interface: OAuth2AuthorizedClientService

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 OAuth2AuthorizedClientService

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 void saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient,
                                 Authentication principal)

Description copied from interface: OAuth2AuthorizedClientService

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

Specified by:

saveAuthorizedClient in interface OAuth2AuthorizedClientService

Parameters:

authorizedClient - the authorized client

principal - the End-User Authentication (Resource Owner)

removeAuthorizedClient

public void removeAuthorizedClient(java.lang.String clientRegistrationId,
                                   java.lang.String principalName)

Description copied from interface: OAuth2AuthorizedClientService

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

Specified by:

removeAuthorizedClient in interface OAuth2AuthorizedClientService

Parameters:

clientRegistrationId - the identifier for the client's registration

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

setAuthorizedClientRowMapper

public final void setAuthorizedClientRowMapper(org.springframework.jdbc.core.RowMapper<OAuth2AuthorizedClient> authorizedClientRowMapper)

Sets the RowMapper used for mapping the current row in java.sql.ResultSet to OAuth2AuthorizedClient. The default is JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientRowMapper.

Parameters:

authorizedClientRowMapper - the RowMapper used for mapping the current row in java.sql.ResultSet to OAuth2AuthorizedClient

setAuthorizedClientParametersMapper

public final void setAuthorizedClientParametersMapper(java.util.function.Function<JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder,java.util.List<org.springframework.jdbc.core.SqlParameterValue>> authorizedClientParametersMapper)

Sets the Function used for mapping JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder to a List of SqlParameterValue. The default is JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientParametersMapper.

Parameters:

authorizedClientParametersMapper - the Function used for mapping JdbcOAuth2AuthorizedClientService.OAuth2AuthorizedClientHolder to a List of SqlParameterValue