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

Class JdbcOAuth2AuthorizationService

java.lang.Object

org.springframework.security.oauth2.server.authorization.JdbcOAuth2AuthorizationService

All Implemented Interfaces:

OAuth2AuthorizationService

@ImportRuntimeHints(org.springframework.security.oauth2.server.authorization.JdbcOAuth2AuthorizationService.JdbcOAuth2AuthorizationServiceRuntimeHintsRegistrar.class)
public class JdbcOAuth2AuthorizationService
extends Object
implements OAuth2AuthorizationService

A JDBC implementation of an OAuth2AuthorizationService that uses a JdbcOperations for OAuth2Authorization persistence.

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

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

Since:

0.1.2

See Also:

• OAuth2AuthorizationService
• OAuth2Authorization
• JdbcOperations
• RowMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcOAuth2AuthorizationService.OAuth2AuthorizationParametersMapper	The default Function that maps OAuth2Authorization to a List of SqlParameterValue.
static class	JdbcOAuth2AuthorizationService.OAuth2AuthorizationRowMapper	The default RowMapper that maps the current row in java.sql.ResultSet to OAuth2Authorization.

Constructor Summary

Constructors

Constructor	Description
JdbcOAuth2AuthorizationService(org.springframework.jdbc.core.JdbcOperations jdbcOperations, RegisteredClientRepository registeredClientRepository)	Constructs a JdbcOAuth2AuthorizationService using the provided parameters.
JdbcOAuth2AuthorizationService(org.springframework.jdbc.core.JdbcOperations jdbcOperations, RegisteredClientRepository registeredClientRepository, org.springframework.jdbc.support.lob.LobHandler lobHandler)	Constructs a JdbcOAuth2AuthorizationService using the provided parameters.

Method Summary

Modifier and Type	Method	Description
OAuth2Authorization	findById(String id)	Returns the OAuth2Authorization identified by the provided id, or null if not found.
OAuth2Authorization	findByToken(String token, OAuth2TokenType tokenType)	Returns the OAuth2Authorization containing the provided token, or null if not found.
protected final Function<OAuth2Authorization,List<org.springframework.jdbc.core.SqlParameterValue>>	getAuthorizationParametersMapper()
protected final org.springframework.jdbc.core.RowMapper<OAuth2Authorization>	getAuthorizationRowMapper()
protected final org.springframework.jdbc.core.JdbcOperations	getJdbcOperations()
protected final org.springframework.jdbc.support.lob.LobHandler	getLobHandler()
void	remove(OAuth2Authorization authorization)	Removes the OAuth2Authorization.
void	save(OAuth2Authorization authorization)	Saves the OAuth2Authorization.
final void	setAuthorizationParametersMapper(Function<OAuth2Authorization,List<org.springframework.jdbc.core.SqlParameterValue>> authorizationParametersMapper)	Sets the Function used for mapping OAuth2Authorization to a List of SqlParameterValue.
final void	setAuthorizationRowMapper(org.springframework.jdbc.core.RowMapper<OAuth2Authorization> authorizationRowMapper)	Sets the RowMapper used for mapping the current row in java.sql.ResultSet to OAuth2Authorization.

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcOAuth2AuthorizationService

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

Constructs a JdbcOAuth2AuthorizationService using the provided parameters.

Parameters:

jdbcOperations - the JDBC operations

registeredClientRepository - the registered client repository

JdbcOAuth2AuthorizationService

public JdbcOAuth2AuthorizationService(org.springframework.jdbc.core.JdbcOperations jdbcOperations,
 RegisteredClientRepository registeredClientRepository,
 org.springframework.jdbc.support.lob.LobHandler lobHandler)

Constructs a JdbcOAuth2AuthorizationService using the provided parameters.

Parameters:

jdbcOperations - the JDBC operations

registeredClientRepository - the registered client repository

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

Method Details

save

public void save(OAuth2Authorization authorization)

Description copied from interface: OAuth2AuthorizationService

Saves the OAuth2Authorization.

Specified by:

save in interface OAuth2AuthorizationService

Parameters:

authorization - the OAuth2Authorization

remove

public void remove(OAuth2Authorization authorization)

Description copied from interface: OAuth2AuthorizationService

Removes the OAuth2Authorization.

Specified by:

remove in interface OAuth2AuthorizationService

Parameters:

authorization - the OAuth2Authorization

findById

@Nullable
public OAuth2Authorization findById(String id)

Description copied from interface: OAuth2AuthorizationService

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

Specified by:

findById in interface OAuth2AuthorizationService

Parameters:

id - the authorization identifier

Returns:

the OAuth2Authorization if found, otherwise null

findByToken

@Nullable
public OAuth2Authorization findByToken(String token,
 @Nullable
 OAuth2TokenType tokenType)

Description copied from interface: OAuth2AuthorizationService

Returns the OAuth2Authorization containing the provided token, or null if not found.

Specified by:

findByToken in interface OAuth2AuthorizationService

Parameters:

token - the token credential

tokenType - the token type

Returns:

the OAuth2Authorization if found, otherwise null

setAuthorizationRowMapper

public final void setAuthorizationRowMapper(org.springframework.jdbc.core.RowMapper<OAuth2Authorization> authorizationRowMapper)

Sets the RowMapper used for mapping the current row in java.sql.ResultSet to OAuth2Authorization. The default is JdbcOAuth2AuthorizationService.OAuth2AuthorizationRowMapper.

Parameters:

authorizationRowMapper - the RowMapper used for mapping the current row in ResultSet to OAuth2Authorization

setAuthorizationParametersMapper

public final void setAuthorizationParametersMapper(Function<OAuth2Authorization,List<org.springframework.jdbc.core.SqlParameterValue>> authorizationParametersMapper)

Sets the Function used for mapping OAuth2Authorization to a List of SqlParameterValue. The default is JdbcOAuth2AuthorizationService.OAuth2AuthorizationParametersMapper.

Parameters:

authorizationParametersMapper - the Function used for mapping OAuth2Authorization to a List of SqlParameterValue

getJdbcOperations

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

getLobHandler

protected final org.springframework.jdbc.support.lob.LobHandler getLobHandler()

getAuthorizationRowMapper

protected final org.springframework.jdbc.core.RowMapper<OAuth2Authorization> getAuthorizationRowMapper()

getAuthorizationParametersMapper

protected final Function<OAuth2Authorization,List<org.springframework.jdbc.core.SqlParameterValue>> getAuthorizationParametersMapper()