Skip to content

Commit 692a8c4

Browse files
committed
Rename property for registering default Servlet
As a follow-up for gh-21214, this commit renames the property to: `"server.servlet.register-default-servlet=false"` Closes gh-21214
1 parent c7c01f8 commit 692a8c4

File tree

4 files changed

+15
-51
lines changed

4 files changed

+15
-51
lines changed

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
import org.springframework.boot.web.server.Http2;
3939
import org.springframework.boot.web.server.Shutdown;
4040
import org.springframework.boot.web.server.Ssl;
41-
import org.springframework.boot.web.servlet.server.DefaultServlet;
4241
import org.springframework.boot.web.servlet.server.Encoding;
4342
import org.springframework.boot.web.servlet.server.Jsp;
4443
import org.springframework.boot.web.servlet.server.Session;
@@ -227,8 +226,10 @@ public static class Servlet {
227226
*/
228227
private String applicationDisplayName = "application";
229228

230-
@NestedConfigurationProperty
231-
private final DefaultServlet defaultServlet = new DefaultServlet();
229+
/**
230+
* Whether to register the default Servlet with the container.
231+
*/
232+
private boolean registerDefaultServlet = true;
232233

233234
@NestedConfigurationProperty
234235
private final Encoding encoding = new Encoding();
@@ -263,12 +264,16 @@ public void setApplicationDisplayName(String displayName) {
263264
this.applicationDisplayName = displayName;
264265
}
265266

266-
public Map<String, String> getContextParameters() {
267-
return this.contextParameters;
267+
public boolean isRegisterDefaultServlet() {
268+
return this.registerDefaultServlet;
268269
}
269270

270-
public DefaultServlet getDefaultServlet() {
271-
return this.defaultServlet;
271+
public void setRegisterDefaultServlet(boolean registerDefaultServlet) {
272+
this.registerDefaultServlet = registerDefaultServlet;
273+
}
274+
275+
public Map<String, String> getContextParameters() {
276+
return this.contextParameters;
272277
}
273278

274279
public Encoding getEncoding() {

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/ServletWebServerFactoryCustomizer.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ public void customize(ConfigurableServletWebServerFactory factory) {
5353
map.from(this.serverProperties::getAddress).to(factory::setAddress);
5454
map.from(this.serverProperties.getServlet()::getContextPath).to(factory::setContextPath);
5555
map.from(this.serverProperties.getServlet()::getApplicationDisplayName).to(factory::setDisplayName);
56-
map.from(this.serverProperties.getServlet().getDefaultServlet()::isRegistered)
57-
.to(factory::setRegisterDefaultServlet);
56+
map.from(this.serverProperties.getServlet()::isRegisterDefaultServlet).to(factory::setRegisterDefaultServlet);
5857
map.from(this.serverProperties.getServlet()::getSession).to(factory::setSession);
5958
map.from(this.serverProperties::getSsl).to(factory::setSsl);
6059
map.from(this.serverProperties.getServlet()::getJsp).to(factory::setJsp);

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/servlet/ServletWebServerFactoryCustomizerTests.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ void testCustomizeDisplayName() {
7777
@Test
7878
void testCustomizeDefaultServlet() {
7979
ConfigurableServletWebServerFactory factory = mock(ConfigurableServletWebServerFactory.class);
80-
this.properties.getServlet().getDefaultServlet().setRegistered(true);
80+
this.properties.getServlet().setRegisterDefaultServlet(false);
8181
this.customizer.customize(factory);
82-
verify(factory).setRegisterDefaultServlet(true);
82+
verify(factory).setRegisterDefaultServlet(false);
8383
}
8484

8585
@Test

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/DefaultServlet.java

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)