Skip to content

Refactor ServerAuthorizationRequestRepository to remove unnecessary generic #15435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Refactor ServerAuthorizationRequestRepository to remove unnecessary generic #15435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions config/src/main/java/org/springframework/security/config/web/server/ServerHttpSecurity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4108,7 +4108,7 @@ public final class OAuth2LoginSpec {

private ServerOAuth2AuthorizedClientRepository authorizedClientRepository;

private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository;
private ServerAuthorizationRequestRepository authorizationRequestRepository;

private ReactiveAuthenticationManager authenticationManager;

Expand Down Expand Up @@ -4314,7 +4314,7 @@ public OAuth2LoginSpec authorizedClientRepository(
* @since 5.2
*/
public OAuth2LoginSpec authorizationRequestRepository(
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository) {
ServerAuthorizationRequestRepository authorizationRequestRepository) {
this.authorizationRequestRepository = authorizationRequestRepository;
return this;
}
Expand Down Expand Up @@ -4380,7 +4380,7 @@ protected void configure(ServerHttpSecurity http) {
ReactiveClientRegistrationRepository clientRegistrationRepository = getClientRegistrationRepository();
ServerOAuth2AuthorizedClientRepository authorizedClientRepository = getAuthorizedClientRepository();
OAuth2AuthorizationRequestRedirectWebFilter oauthRedirectFilter = getRedirectWebFilter();
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = getAuthorizationRequestRepository();
ServerAuthorizationRequestRepository authorizationRequestRepository = getAuthorizationRequestRepository();
oauthRedirectFilter.setAuthorizationRequestRepository(authorizationRequestRepository);
oauthRedirectFilter.setAuthorizationRedirectStrategy(getAuthorizationRedirectStrategy());
oauthRedirectFilter.setRequestCache(http.requestCache.requestCache);
Expand Down Expand Up @@ -4553,7 +4553,7 @@ private ServerOAuth2AuthorizedClientRepository getAuthorizedClientRepository() {
return result;
}

private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> getAuthorizationRequestRepository() {
private ServerAuthorizationRequestRepository getAuthorizationRequestRepository() {
if (this.authorizationRequestRepository == null) {
this.authorizationRequestRepository = new WebSessionOAuth2ServerAuthorizationRequestRepository();
}
Expand Down Expand Up @@ -4737,7 +4737,7 @@ public final class OAuth2ClientSpec {

private ReactiveAuthenticationManager authenticationManager;

private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository;
private ServerAuthorizationRequestRepository authorizationRequestRepository;

private ServerOAuth2AuthorizationRequestResolver authorizationRequestResolver;

Expand Down Expand Up @@ -4823,12 +4823,12 @@ public OAuth2ClientSpec authorizedClientRepository(
* @since 5.2
*/
public OAuth2ClientSpec authorizationRequestRepository(
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository) {
ServerAuthorizationRequestRepository authorizationRequestRepository) {
this.authorizationRequestRepository = authorizationRequestRepository;
return this;
}

private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> getAuthorizationRequestRepository() {
private ServerAuthorizationRequestRepository getAuthorizationRequestRepository() {
if (this.authorizationRequestRepository == null) {
this.authorizationRequestRepository = new WebSessionOAuth2ServerAuthorizationRequestRepository();
}
Expand Down
2 changes: 1 addition & 1 deletion ...g/src/main/kotlin/org/springframework/security/config/web/server/ServerOAuth2ClientDsl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class ServerOAuth2ClientDsl {
var authenticationConverter: ServerAuthenticationConverter? = null
var clientRegistrationRepository: ReactiveClientRegistrationRepository? = null
var authorizedClientRepository: ServerOAuth2AuthorizedClientRepository? = null
var authorizationRequestRepository: ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest>? = null
var authorizationRequestRepository: ServerAuthorizationRequestRepository? = null
var authorizationRedirectStrategy: ServerRedirectStrategy? = null

internal fun get(): (ServerHttpSecurity.OAuth2ClientSpec) -> Unit {
Expand Down
2 changes: 1 addition & 1 deletion ...ig/src/main/kotlin/org/springframework/security/config/web/server/ServerOAuth2LoginDsl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class ServerOAuth2LoginDsl {
var clientRegistrationRepository: ReactiveClientRegistrationRepository? = null
var authorizedClientService: ReactiveOAuth2AuthorizedClientService? = null
var authorizedClientRepository: ServerOAuth2AuthorizedClientRepository? = null
var authorizationRequestRepository: ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest>? = null
var authorizationRequestRepository: ServerAuthorizationRequestRepository? = null
var authorizationRequestResolver: ServerOAuth2AuthorizationRequestResolver? = null
var authorizationRedirectStrategy: ServerRedirectStrategy? = null
var authenticationMatcher: ServerWebExchangeMatcher? = null
Expand Down
8 changes: 4 additions & 4 deletions ...g/src/test/java/org/springframework/security/config/web/server/OAuth2ClientSpecTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ public void oauth2ClientWhenCustomObjectsThenUsed() {
OAuth2ClientCustomConfig config = this.spring.getContext().getBean(OAuth2ClientCustomConfig.class);
ServerAuthenticationConverter converter = config.authenticationConverter;
ReactiveAuthenticationManager manager = config.manager;
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = config.authorizationRequestRepository;
ServerAuthorizationRequestRepository authorizationRequestRepository = config.authorizationRequestRepository;
ServerOAuth2AuthorizationRequestResolver resolver = config.resolver;
ServerRequestCache requestCache = config.requestCache;
OAuth2AuthorizationRequest authorizationRequest = TestOAuth2AuthorizationRequests.request()
Expand Down Expand Up @@ -181,7 +181,7 @@ public void oauth2ClientWhenCustomObjectsInLambdaThenUsed() {
.getBean(OAuth2ClientInLambdaCustomConfig.class);
ServerAuthenticationConverter converter = config.authenticationConverter;
ReactiveAuthenticationManager manager = config.manager;
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = config.authorizationRequestRepository;
ServerAuthorizationRequestRepository authorizationRequestRepository = config.authorizationRequestRepository;
ServerRequestCache requestCache = config.requestCache;
OAuth2AuthorizationRequest authorizationRequest = TestOAuth2AuthorizationRequests.request()
.redirectUri("/authorize/oauth2/code/registration-id")
Expand Down Expand Up @@ -272,7 +272,7 @@ static class OAuth2ClientCustomConfig {

ServerAuthenticationConverter authenticationConverter = mock(ServerAuthenticationConverter.class);

ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = mock(
ServerAuthorizationRequestRepository authorizationRequestRepository = mock(
ServerAuthorizationRequestRepository.class);

ServerOAuth2AuthorizationRequestResolver resolver = mock(ServerOAuth2AuthorizationRequestResolver.class);
Expand Down Expand Up @@ -303,7 +303,7 @@ static class OAuth2ClientInLambdaCustomConfig {

ServerAuthenticationConverter authenticationConverter = mock(ServerAuthenticationConverter.class);

ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = mock(
ServerAuthorizationRequestRepository authorizationRequestRepository = mock(
ServerAuthorizationRequestRepository.class);

ServerRequestCache requestCache = mock(ServerRequestCache.class);
Expand Down
4 changes: 2 additions & 2 deletions config/src/test/java/org/springframework/security/config/web/server/OAuth2LoginTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ public void oauth2AuthorizeWhenCustomObjectsThenUsed() {
OAuth2AuthorizeWithMockObjectsConfig config = this.spring.getContext()
.getBean(OAuth2AuthorizeWithMockObjectsConfig.class);
ServerOAuth2AuthorizedClientRepository authorizedClientRepository = config.authorizedClientRepository;
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = config.authorizationRequestRepository;
ServerAuthorizationRequestRepository authorizationRequestRepository = config.authorizationRequestRepository;
ServerRequestCache requestCache = config.requestCache;
given(authorizedClientRepository.loadAuthorizedClient(any(), any(), any())).willReturn(Mono.empty());
given(authorizationRequestRepository.saveAuthorizationRequest(any(), any())).willReturn(Mono.empty());
Expand Down Expand Up @@ -670,7 +670,7 @@ static class OAuth2AuthorizeWithMockObjectsConfig {
ServerOAuth2AuthorizedClientRepository authorizedClientRepository = mock(
ServerOAuth2AuthorizedClientRepository.class);

ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = mock(
ServerAuthorizationRequestRepository authorizationRequestRepository = mock(
ServerAuthorizationRequestRepository.class);

ServerRequestCache requestCache = mock(ServerRequestCache.class);
Expand Down
2 changes: 1 addition & 1 deletion ...src/test/java/org/springframework/security/config/web/server/ServerHttpSecurityTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ public void shouldConfigureRequestCacheForOAuth2LoginAuthenticationEntryPointAnd

@Test
public void shouldConfigureAuthorizationRequestRepositoryForOAuth2Login() {
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = mock(
ServerAuthorizationRequestRepository authorizationRequestRepository = mock(
ServerAuthorizationRequestRepository.class);
ReactiveClientRegistrationRepository clientRegistrationRepository = mock(
ReactiveClientRegistrationRepository.class);
Expand Down
6 changes: 3 additions & 3 deletions .../test/kotlin/org/springframework/security/config/web/server/ServerOAuth2ClientDslTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ class ServerOAuth2ClientDslTests {
open class AuthorizationRequestRepositoryConfig {

companion object {
val AUTHORIZATION_REQUEST_REPOSITORY : ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> = WebSessionOAuth2ServerAuthorizationRequestRepository()
val AUTHORIZATION_REQUEST_REPOSITORY : ServerAuthorizationRequestRepository = WebSessionOAuth2ServerAuthorizationRequestRepository()
}

@Bean
Expand Down Expand Up @@ -203,7 +203,7 @@ class ServerOAuth2ClientDslTests {
open class AuthenticationConverterConfig {

companion object {
val AUTHORIZATION_REQUEST_REPOSITORY: ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> = WebSessionOAuth2ServerAuthorizationRequestRepository()
val AUTHORIZATION_REQUEST_REPOSITORY: ServerAuthorizationRequestRepository = WebSessionOAuth2ServerAuthorizationRequestRepository()
val AUTHENTICATION_CONVERTER: ServerAuthenticationConverter =
ServerBearerTokenAuthenticationConverter()
}
Expand Down Expand Up @@ -257,7 +257,7 @@ class ServerOAuth2ClientDslTests {
open class AuthenticationManagerConfig {

companion object {
val AUTHORIZATION_REQUEST_REPOSITORY: ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> = WebSessionOAuth2ServerAuthorizationRequestRepository()
val AUTHORIZATION_REQUEST_REPOSITORY: ServerAuthorizationRequestRepository = WebSessionOAuth2ServerAuthorizationRequestRepository()
val AUTHENTICATION_CONVERTER: ServerAuthenticationConverter =
ServerBearerTokenAuthenticationConverter()
val AUTHENTICATION_MANAGER: ReactiveAuthenticationManager = NoopReactiveAuthenticationManager()
Expand Down
2 changes: 1 addition & 1 deletion ...c/test/kotlin/org/springframework/security/config/web/server/ServerOAuth2LoginDslTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ class ServerOAuth2LoginDslTests {
open class AuthorizationRequestRepositoryConfig {

companion object {
val AUTHORIZATION_REQUEST_REPOSITORY: ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> = WebSessionOAuth2ServerAuthorizationRequestRepository()
val AUTHORIZATION_REQUEST_REPOSITORY: ServerAuthorizationRequestRepository = WebSessionOAuth2ServerAuthorizationRequestRepository()
}

@Bean
Expand Down
4 changes: 2 additions & 2 deletions ...ingframework/security/oauth2/client/web/server/OAuth2AuthorizationCodeGrantWebFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public class OAuth2AuthorizationCodeGrantWebFilter implements WebFilter {

private final ServerOAuth2AuthorizedClientRepository authorizedClientRepository;

private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = new WebSessionOAuth2ServerAuthorizationRequestRepository();
private ServerAuthorizationRequestRepository authorizationRequestRepository = new WebSessionOAuth2ServerAuthorizationRequestRepository();

private ServerAuthenticationSuccessHandler authenticationSuccessHandler;

Expand Down Expand Up @@ -168,7 +168,7 @@ public OAuth2AuthorizationCodeGrantWebFilter(ReactiveAuthenticationManager authe
* @since 5.2
*/
public final void setAuthorizationRequestRepository(
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository) {
ServerAuthorizationRequestRepository authorizationRequestRepository) {
Assert.notNull(authorizationRequestRepository, "authorizationRequestRepository cannot be null");
this.authorizationRequestRepository = authorizationRequestRepository;
updateDefaultAuthenticationConverter();
Expand Down
4 changes: 2 additions & 2 deletions ...mework/security/oauth2/client/web/server/OAuth2AuthorizationRequestRedirectWebFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public class OAuth2AuthorizationRequestRedirectWebFilter implements WebFilter {

private final ServerOAuth2AuthorizationRequestResolver authorizationRequestResolver;

private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = new WebSessionOAuth2ServerAuthorizationRequestRepository();
private ServerAuthorizationRequestRepository authorizationRequestRepository = new WebSessionOAuth2ServerAuthorizationRequestRepository();

private ServerRequestCache requestCache = new WebSessionServerRequestCache();

Expand Down Expand Up @@ -114,7 +114,7 @@ public void setAuthorizationRedirectStrategy(ServerRedirectStrategy authorizatio
* {@link OAuth2AuthorizationRequest}'s
*/
public final void setAuthorizationRequestRepository(
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository) {
ServerAuthorizationRequestRepository authorizationRequestRepository) {
Assert.notNull(authorizationRequestRepository, "authorizationRequestRepository cannot be null");
this.authorizationRequestRepository = authorizationRequestRepository;
}
Expand Down
12 changes: 6 additions & 6 deletions ...ringframework/security/oauth2/client/web/server/ServerAuthorizationRequestRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -34,29 +34,29 @@
* used by the {@link OAuth2LoginAuthenticationFilter} for resolving the associated
* Authorization Request when handling the callback of the Authorization Response.
*
* @param <T> The type of OAuth 2.0 Authorization Request
* @author Rob Winch
* @author Jinwoo Bae
* @since 5.1
* @see OAuth2AuthorizationRequest
* @see HttpSessionOAuth2AuthorizationRequestRepository
*/
public interface ServerAuthorizationRequestRepository<T extends OAuth2AuthorizationRequest> {
public interface ServerAuthorizationRequestRepository {

/**
* Returns the {@link OAuth2AuthorizationRequest} associated to the provided
* {@code HttpServletRequest} or {@code null} if not available.
* @param exchange the {@code ServerWebExchange}
* @return the {@link OAuth2AuthorizationRequest} or {@code null} if not available
*/
Mono<T> loadAuthorizationRequest(ServerWebExchange exchange);
Mono<OAuth2AuthorizationRequest> loadAuthorizationRequest(ServerWebExchange exchange);

/**
* Persists the {@link OAuth2AuthorizationRequest} associating it to the provided
* {@code HttpServletRequest} and/or {@code HttpServletResponse}.
* @param authorizationRequest the {@link OAuth2AuthorizationRequest}
* @param exchange the {@code ServerWebExchange}
*/
Mono<Void> saveAuthorizationRequest(T authorizationRequest, ServerWebExchange exchange);
Mono<Void> saveAuthorizationRequest(OAuth2AuthorizationRequest authorizationRequest, ServerWebExchange exchange);

/**
* Removes and returns the {@link OAuth2AuthorizationRequest} associated to the
Expand All @@ -65,6 +65,6 @@ public interface ServerAuthorizationRequestRepository<T extends OAuth2Authorizat
* @return the removed {@link OAuth2AuthorizationRequest} or {@code null} if not
* available
*/
Mono<T> removeAuthorizationRequest(ServerWebExchange exchange);
Mono<OAuth2AuthorizationRequest> removeAuthorizationRequest(ServerWebExchange exchange);

}
5 changes: 2 additions & 3 deletions ...y/oauth2/client/web/server/ServerOAuth2AuthorizationCodeAuthenticationTokenConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class ServerOAuth2AuthorizationCodeAuthenticationTokenConverter implement

static final String CLIENT_REGISTRATION_NOT_FOUND_ERROR_CODE = "client_registration_not_found";

private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository = new WebSessionOAuth2ServerAuthorizationRequestRepository();
private ServerAuthorizationRequestRepository authorizationRequestRepository = new WebSessionOAuth2ServerAuthorizationRequestRepository();

private final ReactiveClientRegistrationRepository clientRegistrationRepository;

Expand All @@ -62,8 +62,7 @@ public ServerOAuth2AuthorizationCodeAuthenticationTokenConverter(
* {@link WebSessionOAuth2ServerAuthorizationRequestRepository}.
* @param authorizationRequestRepository the repository to use.
*/
public void setAuthorizationRequestRepository(
ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository) {
public void setAuthorizationRequestRepository(ServerAuthorizationRequestRepository authorizationRequestRepository) {
Assert.notNull(authorizationRequestRepository, "authorizationRequestRepository cannot be null");
this.authorizationRequestRepository = authorizationRequestRepository;
}
Expand Down
5 changes: 3 additions & 2 deletions ...curity/oauth2/client/web/server/WebSessionOAuth2ServerAuthorizationRequestRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -34,12 +34,13 @@
*
* @author Rob Winch
* @author Steve Riesenberg
* @author Jinwoo Bae
* @since 5.1
* @see AuthorizationRequestRepository
* @see OAuth2AuthorizationRequest
*/
public final class WebSessionOAuth2ServerAuthorizationRequestRepository
implements ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> {
implements ServerAuthorizationRequestRepository {

private static final String DEFAULT_AUTHORIZATION_REQUEST_ATTR_NAME = WebSessionOAuth2ServerAuthorizationRequestRepository.class
.getName() + ".AUTHORIZATION_REQUEST";
Expand Down
2 changes: 1 addition & 1 deletion ...amework/security/oauth2/client/web/server/OAuth2AuthorizationCodeGrantWebFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public class OAuth2AuthorizationCodeGrantWebFilterTests {
private ServerOAuth2AuthorizedClientRepository authorizedClientRepository;

@Mock
private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository;
private ServerAuthorizationRequestRepository authorizationRequestRepository;

@BeforeEach
public void setup() {
Expand Down
3 changes: 1 addition & 2 deletions ...k/security/oauth2/client/web/server/OAuth2AuthorizationRequestRedirectWebFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
import org.springframework.security.oauth2.client.registration.ClientRegistration;
import org.springframework.security.oauth2.client.registration.ReactiveClientRegistrationRepository;
import org.springframework.security.oauth2.client.registration.TestClientRegistrations;
import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest;
import org.springframework.security.web.server.ServerRedirectStrategy;
import org.springframework.security.web.server.savedrequest.ServerRequestCache;
import org.springframework.test.web.reactive.server.FluxExchangeResult;
Expand All @@ -62,7 +61,7 @@ public class OAuth2AuthorizationRequestRedirectWebFilterTests {
private ReactiveClientRegistrationRepository clientRepository;

@Mock
private ServerAuthorizationRequestRepository<OAuth2AuthorizationRequest> authzRequestRepository;
private ServerAuthorizationRequestRepository authzRequestRepository;

@Mock
private ServerRequestCache requestCache;
Expand Down