Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document how to obtain ServletContext with an embedded container setup

Browse Source 
Closes gh-24561
This commit is contained in:
Madhura Bhave
2022-03-08 17:34:35 -08:00
parent 708e57eafb
commit d240e293db
2 changed files with 47 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/developing-web-applications.adoc
View File

@@ -818,6 +818,17 @@ Usually a `TomcatServletWebServerFactory`, `JettyServletWebServerFactory`, or `U
NOTE: You usually do not need to be aware of these implementation classes.
Most applications are auto-configured, and the appropriate `ApplicationContext` and `ServletWebServerFactory` are created on your behalf.
In an embedded container setup, the `ServletContext` is set as part of server startup which happens during application context initialization.
Because of this beans in the `ApplicationContext` cannot be reliably initialized with a `ServletContext`.
One way to get around this is to inject `ApplicationContext` as a dependency of the bean and access the `ServletContext` only when it is needed.
Another way is to use a callback once the server has started.
This can be done using an `ApplicationListener` which listens for the `ApplicationStartedEvent` as follows:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/developingwebapplications/embeddedcontainer/applicationcontext/MyDemoBean.java[]
----
[[features.developing-web-applications.embedded-container.customizing]]