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

Class JdbcRegisteredClientRepository

java.lang.Object

org.springframework.security.oauth2.server.authorization.client.JdbcRegisteredClientRepository

All Implemented Interfaces:

RegisteredClientRepository

@ImportRuntimeHints(org.springframework.security.oauth2.server.authorization.client.JdbcRegisteredClientRepository.JdbcRegisteredClientRepositoryRuntimeHintsRegistrar.class)
public class JdbcRegisteredClientRepository
extends Object
implements RegisteredClientRepository

A JDBC implementation of a RegisteredClientRepository that uses a JdbcOperations for RegisteredClient persistence.

IMPORTANT: This RegisteredClientRepository depends on the table definition described in "classpath:org/springframework/security/oauth2/server/authorization/client/oauth2-registered-client-schema.sql" and therefore MUST be defined in the database schema.

NOTE: This RegisteredClientRepository is a simplified JDBC implementation that MAY be used in a production environment. However, it does have limitations as it likely won't perform well in an environment requiring high throughput. The expectation is that the consuming application will provide their own implementation of RegisteredClientRepository that meets the performance requirements for its deployment environment.

Since:

0.1.2

See Also:

• RegisteredClientRepository
• RegisteredClient
• JdbcOperations
• RowMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcRegisteredClientRepository.RegisteredClientParametersMapper	The default Function that maps RegisteredClient to a List of SqlParameterValue.
static class	JdbcRegisteredClientRepository.RegisteredClientRowMapper	The default RowMapper that maps the current row in java.sql.ResultSet to RegisteredClient.

Constructor Summary

Constructors

Constructor	Description
JdbcRegisteredClientRepository(org.springframework.jdbc.core.JdbcOperations jdbcOperations)	Constructs a JdbcRegisteredClientRepository using the provided parameters.

Method Summary

Modifier and Type	Method	Description
RegisteredClient	findByClientId(String clientId)	Returns the registered client identified by the provided clientId, or null if not found.
RegisteredClient	findById(String id)	Returns the registered client identified by the provided id, or null if not found.
protected final org.springframework.jdbc.core.JdbcOperations	getJdbcOperations()
protected final Function<RegisteredClient,List<org.springframework.jdbc.core.SqlParameterValue>>	getRegisteredClientParametersMapper()
protected final org.springframework.jdbc.core.RowMapper<RegisteredClient>	getRegisteredClientRowMapper()
void	save(RegisteredClient registeredClient)	Saves the registered client.
final void	setRegisteredClientParametersMapper(Function<RegisteredClient,List<org.springframework.jdbc.core.SqlParameterValue>> registeredClientParametersMapper)	Sets the Function used for mapping RegisteredClient to a List of SqlParameterValue.
final void	setRegisteredClientRowMapper(org.springframework.jdbc.core.RowMapper<RegisteredClient> registeredClientRowMapper)	Sets the RowMapper used for mapping the current row in java.sql.ResultSet to RegisteredClient.

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcRegisteredClientRepository

public JdbcRegisteredClientRepository(org.springframework.jdbc.core.JdbcOperations jdbcOperations)

Constructs a JdbcRegisteredClientRepository using the provided parameters.

Parameters:

jdbcOperations - the JDBC operations

Method Details

save

public void save(RegisteredClient registeredClient)

Description copied from interface: RegisteredClientRepository

Saves the registered client.

IMPORTANT: Sensitive information should be encoded externally from the implementation, e.g. RegisteredClient.getClientSecret()

Specified by:

save in interface RegisteredClientRepository

Parameters:

registeredClient - the RegisteredClient

findById

public RegisteredClient findById(String id)

Description copied from interface: RegisteredClientRepository

Returns the registered client identified by the provided id, or null if not found.

Specified by:

findById in interface RegisteredClientRepository

Parameters:

id - the registration identifier

Returns:

the RegisteredClient if found, otherwise null

findByClientId

public RegisteredClient findByClientId(String clientId)

Description copied from interface: RegisteredClientRepository

Returns the registered client identified by the provided clientId, or null if not found.

Specified by:

findByClientId in interface RegisteredClientRepository

Parameters:

clientId - the client identifier

Returns:

the RegisteredClient if found, otherwise null

setRegisteredClientRowMapper

public final void setRegisteredClientRowMapper(org.springframework.jdbc.core.RowMapper<RegisteredClient> registeredClientRowMapper)

Sets the RowMapper used for mapping the current row in java.sql.ResultSet to RegisteredClient. The default is JdbcRegisteredClientRepository.RegisteredClientRowMapper.

Parameters:

registeredClientRowMapper - the RowMapper used for mapping the current row in ResultSet to RegisteredClient

setRegisteredClientParametersMapper

public final void setRegisteredClientParametersMapper(Function<RegisteredClient,List<org.springframework.jdbc.core.SqlParameterValue>> registeredClientParametersMapper)

Sets the Function used for mapping RegisteredClient to a List of SqlParameterValue. The default is JdbcRegisteredClientRepository.RegisteredClientParametersMapper.

Parameters:

registeredClientParametersMapper - the Function used for mapping RegisteredClient to a List of SqlParameterValue

getJdbcOperations

protected final org.springframework.jdbc.core.JdbcOperations getJdbcOperations()

getRegisteredClientRowMapper

protected final org.springframework.jdbc.core.RowMapper<RegisteredClient> getRegisteredClientRowMapper()

getRegisteredClientParametersMapper

protected final Function<RegisteredClient,List<org.springframework.jdbc.core.SqlParameterValue>> getRegisteredClientParametersMapper()