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

Class JdbcOAuth2AuthorizationConsentService

java.lang.Object

org.springframework.security.oauth2.server.authorization.JdbcOAuth2AuthorizationConsentService

All Implemented Interfaces:

OAuth2AuthorizationConsentService

@ImportRuntimeHints(org.springframework.security.oauth2.server.authorization.JdbcOAuth2AuthorizationConsentService.JdbcOAuth2AuthorizationConsentServiceRuntimeHintsRegistrar.class)
public class JdbcOAuth2AuthorizationConsentService
extends Object
implements OAuth2AuthorizationConsentService

A JDBC implementation of an OAuth2AuthorizationConsentService that uses a JdbcOperations for OAuth2AuthorizationConsent persistence.

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

NOTE: This OAuth2AuthorizationConsentService 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 OAuth2AuthorizationConsentService that meets the performance requirements for its deployment environment.

Since:

0.1.2

See Also:

• OAuth2AuthorizationConsentService
• OAuth2AuthorizationConsent
• JdbcOperations
• RowMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcOAuth2AuthorizationConsentService.OAuth2AuthorizationConsentParametersMapper	The default Function that maps OAuth2AuthorizationConsent to a List of SqlParameterValue.
static class	JdbcOAuth2AuthorizationConsentService.OAuth2AuthorizationConsentRowMapper	The default RowMapper that maps the current row in ResultSet to OAuth2AuthorizationConsent.

Constructor Summary

Constructors

Constructor	Description
JdbcOAuth2AuthorizationConsentService(org.springframework.jdbc.core.JdbcOperations jdbcOperations, RegisteredClientRepository registeredClientRepository)	Constructs a JdbcOAuth2AuthorizationConsentService using the provided parameters.

Method Summary

Modifier and Type	Method	Description
OAuth2AuthorizationConsent	findById(String registeredClientId, String principalName)	Returns the OAuth2AuthorizationConsent identified by the provided registeredClientId and principalName, or null if not found.
protected final Function<OAuth2AuthorizationConsent,List<org.springframework.jdbc.core.SqlParameterValue>>	getAuthorizationConsentParametersMapper()
protected final org.springframework.jdbc.core.RowMapper<OAuth2AuthorizationConsent>	getAuthorizationConsentRowMapper()
protected final org.springframework.jdbc.core.JdbcOperations	getJdbcOperations()
void	remove(OAuth2AuthorizationConsent authorizationConsent)	Removes the OAuth2AuthorizationConsent.
void	save(OAuth2AuthorizationConsent authorizationConsent)	Saves the OAuth2AuthorizationConsent.
final void	setAuthorizationConsentParametersMapper(Function<OAuth2AuthorizationConsent,List<org.springframework.jdbc.core.SqlParameterValue>> authorizationConsentParametersMapper)	Sets the Function used for mapping OAuth2AuthorizationConsent to a List of SqlParameterValue.
final void	setAuthorizationConsentRowMapper(org.springframework.jdbc.core.RowMapper<OAuth2AuthorizationConsent> authorizationConsentRowMapper)	Sets the RowMapper used for mapping the current row in java.sql.ResultSet to OAuth2AuthorizationConsent.

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcOAuth2AuthorizationConsentService

public JdbcOAuth2AuthorizationConsentService(org.springframework.jdbc.core.JdbcOperations jdbcOperations,
 RegisteredClientRepository registeredClientRepository)

Constructs a JdbcOAuth2AuthorizationConsentService using the provided parameters.

Parameters:

jdbcOperations - the JDBC operations

registeredClientRepository - the registered client repository

Method Details

save

public void save(OAuth2AuthorizationConsent authorizationConsent)

Description copied from interface: OAuth2AuthorizationConsentService

Saves the OAuth2AuthorizationConsent.

Specified by:

save in interface OAuth2AuthorizationConsentService

Parameters:

authorizationConsent - the OAuth2AuthorizationConsent

remove

public void remove(OAuth2AuthorizationConsent authorizationConsent)

Description copied from interface: OAuth2AuthorizationConsentService

Removes the OAuth2AuthorizationConsent.

Specified by:

remove in interface OAuth2AuthorizationConsentService

Parameters:

authorizationConsent - the OAuth2AuthorizationConsent

findById

@Nullable
public OAuth2AuthorizationConsent findById(String registeredClientId,
 String principalName)

Description copied from interface: OAuth2AuthorizationConsentService

Returns the OAuth2AuthorizationConsent identified by the provided registeredClientId and principalName, or null if not found.

Specified by:

findById in interface OAuth2AuthorizationConsentService

Parameters:

registeredClientId - the identifier for the RegisteredClient

principalName - the name of the Principal

Returns:

the OAuth2AuthorizationConsent if found, otherwise null

setAuthorizationConsentRowMapper

public final void setAuthorizationConsentRowMapper(org.springframework.jdbc.core.RowMapper<OAuth2AuthorizationConsent> authorizationConsentRowMapper)

Sets the RowMapper used for mapping the current row in java.sql.ResultSet to OAuth2AuthorizationConsent. The default is JdbcOAuth2AuthorizationConsentService.OAuth2AuthorizationConsentRowMapper.

Parameters:

authorizationConsentRowMapper - the RowMapper used for mapping the current row in ResultSet to OAuth2AuthorizationConsent

setAuthorizationConsentParametersMapper

public final void setAuthorizationConsentParametersMapper(Function<OAuth2AuthorizationConsent,List<org.springframework.jdbc.core.SqlParameterValue>> authorizationConsentParametersMapper)

Sets the Function used for mapping OAuth2AuthorizationConsent to a List of SqlParameterValue. The default is JdbcOAuth2AuthorizationConsentService.OAuth2AuthorizationConsentParametersMapper.

Parameters:

authorizationConsentParametersMapper - the Function used for mapping OAuth2AuthorizationConsent to a List of SqlParameterValue

getJdbcOperations

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

getAuthorizationConsentRowMapper

protected final org.springframework.jdbc.core.RowMapper<OAuth2AuthorizationConsent> getAuthorizationConsentRowMapper()

getAuthorizationConsentParametersMapper

protected final Function<OAuth2AuthorizationConsent,List<org.springframework.jdbc.core.SqlParameterValue>> getAuthorizationConsentParametersMapper()