ServletWebServerInitializedEvent (spring-boot 2.2.13.RELEASE)

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
```
public class ServletWebServerInitializedEvent
extends WebServerInitializedEvent
```
Event to be published after the ServletWebServerApplicationContext is refreshed and 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:

Serialized Form

Field Summary
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor and Description

ServletWebServerInitializedEvent(WebServer webServer, ServletWebServerApplicationContext applicationContext)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServletWebServerApplicationContext`	`getApplicationContext()` Access 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ServletWebServerInitializedEvent
```
public ServletWebServerInitializedEvent(WebServer webServer,
                                        ServletWebServerApplicationContext applicationContext)
```
- Method Detail
  - getApplicationContext
```
public ServletWebServerApplicationContext 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 class WebServerInitializedEvent
    
    Returns:
    
    the applicationContext that the server was created from

Copyright © 2021 Pivotal Software, Inc.. All rights reserved.