Skip to content

Commit d176650

Browse files
mbhavembhave
committed
Rename clientReg redirectUri to redirectUriTemplate
To keep it consistent with changes made in Spring Security Closes gh-11038
1 parent 3e46b5c commit d176650

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

‎spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/client/OAuth2ClientProperties.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ public static class Registration {
102102
/**
103103
* Redirect URI. May be left blank then using a pre-defined provider.
104104
*/
105-
private String redirectUri;
105+
private String redirectUriTemplate;
106106

107107
/**
108108
* Authorization scopes. May be left blank then using a pre-defined provider.
@@ -154,12 +154,12 @@ public void setAuthorizationGrantType(String authorizationGrantType) {
154154
this.authorizationGrantType = authorizationGrantType;
155155
}
156156

157-
public String getRedirectUri() {
158-
return this.redirectUri;
157+
public String getRedirectUriTemplate() {
158+
return this.redirectUriTemplate;
159159
}
160160

161-
public void setRedirectUri(String redirectUri) {
162-
this.redirectUri = redirectUri;
161+
public void setRedirectUriTemplate(String redirectUriTemplate) {
162+
this.redirectUriTemplate = redirectUriTemplate;
163163
}
164164

165165
public Set<String> getScope() {

‎spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/client/OAuth2ClientPropertiesRegistrationAdapter.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ private static ClientRegistration getClientRegistration(String registrationId,
6161
builder::clientAuthenticationMethod, ClientAuthenticationMethod::new);
6262
copyIfNotNull(properties::getAuthorizationGrantType,
6363
builder::authorizationGrantType, AuthorizationGrantType::new);
64-
copyIfNotNull(properties::getRedirectUri, builder::redirectUri);
64+
copyIfNotNull(properties::getRedirectUriTemplate, builder::redirectUriTemplate);
6565
copyIfNotNull(properties::getScope, builder::scope,
6666
(scope) -> scope.toArray(new String[scope.size()]));
6767
copyIfNotNull(properties::getClientName, builder::clientName);

‎spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/oauth2/client/OAuth2ClientPropertiesRegistrationAdapterTests.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
* Tests for {@link OAuth2ClientPropertiesRegistrationAdapter}.
3535
*
3636
* @author Phillip Webb
37+
* @author Madhura Bhave
3738
*/
3839
public class OAuth2ClientPropertiesRegistrationAdapterTests {
3940

@@ -55,7 +56,7 @@ public void getClientRegistrationsWhenUsingDefinedProviderShouldAdapt()
5556
registration.setClientSecret("clientSecret");
5657
registration.setClientAuthenticationMethod("post");
5758
registration.setAuthorizationGrantType("authorization_code");
58-
registration.setRedirectUri("http://example.com/redirect");
59+
registration.setRedirectUriTemplate("http://example.com/redirect");
5960
registration.setScope(Collections.singleton("scope"));
6061
registration.setClientName("clientName");
6162
properties.getProvider().put("provider", provider);
@@ -77,7 +78,7 @@ public void getClientRegistrationsWhenUsingDefinedProviderShouldAdapt()
7778
org.springframework.security.oauth2.core.ClientAuthenticationMethod.POST);
7879
assertThat(adapted.getAuthorizationGrantType()).isEqualTo(
7980
org.springframework.security.oauth2.core.AuthorizationGrantType.AUTHORIZATION_CODE);
80-
assertThat(adapted.getRedirectUri()).isEqualTo("http://example.com/redirect");
81+
assertThat(adapted.getRedirectUriTemplate()).isEqualTo("http://example.com/redirect");
8182
assertThat(adapted.getScopes()).containsExactly("scope");
8283
assertThat(adapted.getClientName()).isEqualTo("clientName");
8384
}
@@ -110,8 +111,8 @@ public void getClientRegistrationsWhenUsingCommonProviderShouldAdapt()
110111
org.springframework.security.oauth2.core.ClientAuthenticationMethod.BASIC);
111112
assertThat(adapted.getAuthorizationGrantType()).isEqualTo(
112113
org.springframework.security.oauth2.core.AuthorizationGrantType.AUTHORIZATION_CODE);
113-
assertThat(adapted.getRedirectUri()).isEqualTo(
114-
"{scheme}://{serverName}:{serverPort}{contextPath}/login/oauth2/code/{registrationId}");
114+
assertThat(adapted.getRedirectUriTemplate()).isEqualTo(
115+
"{baseUrl}/login/oauth2/code/{registrationId}");
115116
assertThat(adapted.getScopes()).containsExactly("openid", "profile", "email",
116117
"address", "phone");
117118
assertThat(adapted.getClientName()).isEqualTo("Google");
@@ -127,7 +128,7 @@ public void getClientRegistrationsWhenUsingCommonProviderWithOverrideShouldAdapt
127128
registration.setClientSecret("clientSecret");
128129
registration.setClientAuthenticationMethod("post");
129130
registration.setAuthorizationGrantType("authorization_code");
130-
registration.setRedirectUri("http://example.com/redirect");
131+
registration.setRedirectUriTemplate("http://example.com/redirect");
131132
registration.setScope(Collections.singleton("scope"));
132133
registration.setClientName("clientName");
133134
properties.getRegistration().put("registration", registration);
@@ -150,7 +151,7 @@ public void getClientRegistrationsWhenUsingCommonProviderWithOverrideShouldAdapt
150151
org.springframework.security.oauth2.core.ClientAuthenticationMethod.POST);
151152
assertThat(adapted.getAuthorizationGrantType()).isEqualTo(
152153
org.springframework.security.oauth2.core.AuthorizationGrantType.AUTHORIZATION_CODE);
153-
assertThat(adapted.getRedirectUri()).isEqualTo("http://example.com/redirect");
154+
assertThat(adapted.getRedirectUriTemplate()).isEqualTo("http://example.com/redirect");
154155
assertThat(adapted.getScopes()).containsExactly("scope");
155156
assertThat(adapted.getClientName()).isEqualTo("clientName");
156157
}
@@ -194,8 +195,7 @@ public void getClientRegistrationsWhenProviderNotSpecifiedShouldUseRegistrationI
194195
org.springframework.security.oauth2.core.ClientAuthenticationMethod.BASIC);
195196
assertThat(adapted.getAuthorizationGrantType()).isEqualTo(
196197
org.springframework.security.oauth2.core.AuthorizationGrantType.AUTHORIZATION_CODE);
197-
assertThat(adapted.getRedirectUri()).isEqualTo(
198-
"{scheme}://{serverName}:{serverPort}{contextPath}/login/oauth2/code/{registrationId}");
198+
assertThat(adapted.getRedirectUriTemplate()).isEqualTo("{baseUrl}/login/oauth2/code/{registrationId}");
199199
assertThat(adapted.getScopes()).containsExactly("openid", "profile", "email",
200200
"address", "phone");
201201
assertThat(adapted.getClientName()).isEqualTo("Google");

‎spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/oauth2/client/OAuth2WebSecurityConfigurationTests.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ private boolean isEqual(ClientRegistration reg1, ClientRegistration reg2) {
142142
result = result && ObjectUtils.nullSafeEquals(reg1.getClientSecret(),
143143
reg2.getClientSecret());
144144
result = result && ObjectUtils.nullSafeEquals(reg1.getScopes(), reg2.getScopes());
145-
result = result && ObjectUtils.nullSafeEquals(reg1.getRedirectUri(),
146-
reg2.getRedirectUri());
145+
result = result && ObjectUtils.nullSafeEquals(reg1.getRedirectUriTemplate(),
146+
reg2.getRedirectUriTemplate());
147147
result = result && ObjectUtils.nullSafeEquals(reg1.getRegistrationId(),
148148
reg2.getRegistrationId());
149149
result = result && ObjectUtils.nullSafeEquals(reg1.getAuthorizationGrantType(),
@@ -191,7 +191,7 @@ private ClientRegistration getClientRegistration(String id, String userInfoUri)
191191
org.springframework.security.oauth2.core.ClientAuthenticationMethod.BASIC)
192192
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
193193
.scope("read").clientSecret("secret")
194-
.redirectUri("http://redirect-uri.com")
194+
.redirectUriTemplate("http://redirect-uri.com")
195195
.authorizationUri("http://authorization-uri.com")
196196
.tokenUri("http://token-uri.com").userInfoUri(userInfoUri)
197197
.userNameAttributeName("login");

‎spring-boot-project/spring-boot-dependencies/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@
153153
<spring-plugin.version>1.2.0.RELEASE</spring-plugin.version>
154154
<spring-restdocs.version>2.0.0.BUILD-SNAPSHOT</spring-restdocs.version>
155155
<spring-retry.version>1.2.1.RELEASE</spring-retry.version>
156-
<spring-security.version>5.0.0.RC1</spring-security.version>
156+
<spring-security.version>5.0.0.BUILD-SNAPSHOT</spring-security.version>
157157
<spring-session.version>2.0.0.RC1</spring-session.version>
158158
<spring-session-data-mongodb.version>2.0.0.RC1</spring-session-data-mongodb.version>
159159
<spring-social.version>2.0.0.M4</spring-social.version>

0 commit comments

Comments
 (0)