Class ServletWebServerInitializedEvent
java.lang.Object
java.util.EventObject
org.springframework.context.ApplicationEvent
org.springframework.boot.web.context.WebServerInitializedEvent
org.springframework.boot.web.servlet.context.ServletWebServerInitializedEvent
- All Implemented Interfaces:
Serializable
Event to be published after the
WebServer
is ready. Useful for obtaining the
local port of a running server.
Normally it will have been started, but listeners are free to inspect the server and stop and start it if they want to.
- Since:
- 2.0.0
- Author:
- Dave Syer
- See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorDescriptionServletWebServerInitializedEvent
(WebServer webServer, ServletWebServerApplicationContext applicationContext) -
Method Summary
Modifier and TypeMethodDescriptionAccess the application context that the server was created in.Methods inherited from class org.springframework.boot.web.context.WebServerInitializedEvent
getSource, getWebServer
Methods inherited from class org.springframework.context.ApplicationEvent
getTimestamp
Methods inherited from class java.util.EventObject
toString
-
Constructor Details
-
ServletWebServerInitializedEvent
public ServletWebServerInitializedEvent(WebServer webServer, ServletWebServerApplicationContext applicationContext)
-
-
Method Details
-
getApplicationContext
Access the application context that the server was created in. Sometimes it is prudent to check that this matches expectations (like being equal to the current context) before acting on the server itself.- Specified by:
getApplicationContext
in classWebServerInitializedEvent
- Returns:
- the applicationContext that the server was created from
-