Skip to content

Commit 8a27326

Browse files
committed
Add warning when downgrading to Servlet 5.0 to docs
Closes gh-33044
1 parent b4721c9 commit 8a27326

File tree

1 file changed

+12
-0
lines changed
  • spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto

1 file changed

+12
-0
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/webserver.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,18 @@ The following Maven example shows how to exclude Tomcat and include Jetty for Sp
4343

4444
NOTE: The version of the Jakarta Servlet API has been overridden as, unlike Tomcat 10 and Undertow 2.3, Jetty 11 does not support Servlet 6.0.
4545

46+
[WARNING]
47+
====
48+
Downgrading the Servlet API to 5.0 breaks Spring Framework's Servlet-related mocks!
49+
50+
As Jetty needs the Servlet API 5.0, this leaves you with two working arrangements:
51+
52+
* Tests use the Servlet 5.0 API and avoid using Framework's Servlet mocks by only using a full-blown web environment
53+
* Tests use the Servlet 6.0 API and avoid starting Jetty by only using a mock web environment
54+
55+
If a mixture of web environments is required by your application's tests, your test setup may require some structural changes to strictly separate the two web environments.
56+
====
57+
4658
The following Gradle example configures the necessary dependencies and a {gradle-docs}/resolution_rules.html#sec:module_replacement[module replacement] to use Undertow in place of Reactor Netty for Spring WebFlux:
4759

4860
[source,gradle,indent=0,subs="verbatim"]

0 commit comments

Comments
 (0)