org.springframework.boot.web.context

Class WebServerInitializedEvent

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 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 source)

Method Summary

Modifier and Type	Method and Description
abstract ApplicationContext	getApplicationContext() Access the application context that the server was created in.
abstract String	getServerId() Access the WebServer Id used internally to differentiate application / management servers.
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 source)

Method Detail

getWebServer

public WebServer getWebServer()

Access the WebServer.

Returns:

the embedded web server

getApplicationContext

public abstract ApplicationContext 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

getServerId

public abstract String getServerId()

Access the WebServer Id used internally to differentiate application / management servers.

Returns:

the server internal Id