WebServerInitializedEvent (spring-boot 2.2.7.RELEASE)

java.lang.Object
- java.util.EventObject
- - org.springframework.context.ApplicationEvent
  - - org.springframework.boot.web.context.WebServerInitializedEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ReactiveWebServerInitializedEvent, ServletWebServerInitializedEvent
```
public abstract class WebServerInitializedEvent
extends org.springframework.context.ApplicationEvent
```
Event to be published after the application context is refreshed and the WebServer is ready. Useful for obtaining the local port of a running server.

Since:

2.0.0

Author:

Brian Clozel, Stephane Nicoll

See Also:

Serialized Form

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected WebServerInitializedEvent(WebServer webServer)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract WebServerApplicationContext`	`getApplicationContext()` Access the application context that the server was created in.
`WebServer`	`getSource()` Access the source of the event (an `WebServer`).
`WebServer`	`getWebServer()` Access the `WebServer`.

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
  - WebServerInitializedEvent
```
protected WebServerInitializedEvent(WebServer webServer)
```
- Method Detail
  - getWebServer
```
public WebServer getWebServer()
```
    Access the WebServer.
    
    Returns:
    
    the embedded web server
  - getApplicationContext
```
public abstract WebServerApplicationContext 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.
    
    Returns:
    
    the applicationContext that the server was created from
  - getSource
```
public WebServer getSource()
```
    Access the source of the event (an WebServer).
    
    Overrides:
    
    getSource in class EventObject
    
    Returns:
    
    the embedded web server

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