org.springframework.boot.context.embedded

Class EmbeddedServletContainerInitializedEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.boot.context.embedded.EmbeddedServletContainerInitializedEvent

All Implemented Interfaces:

Serializable

public class EmbeddedServletContainerInitializedEvent
extends ApplicationEvent

Event to be published after the context is refreshed and the EmbeddedServletContainer 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.

Author:

Dave Syer

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
EmbeddedServletContainerInitializedEvent(EmbeddedWebApplicationContext applicationContext, EmbeddedServletContainer source)

Method Summary

Modifier and Type	Method and Description
EmbeddedWebApplicationContext	getApplicationContext() Access the application context that the container was created in.
EmbeddedServletContainer	getEmbeddedServletContainer() Access the EmbeddedServletContainer.
EmbeddedServletContainer	getSource() Access the source of the event (an EmbeddedServletContainer).

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

EmbeddedServletContainerInitializedEvent

public EmbeddedServletContainerInitializedEvent(EmbeddedWebApplicationContext applicationContext,
                                                EmbeddedServletContainer source)

Method Detail

getEmbeddedServletContainer

public EmbeddedServletContainer getEmbeddedServletContainer()

Access the EmbeddedServletContainer.

Returns:

the embedded servlet container

getSource

public EmbeddedServletContainer getSource()

Access the source of the event (an EmbeddedServletContainer).

Overrides:

getSource in class EventObject

Returns:

the embedded servlet container

getApplicationContext

public EmbeddedWebApplicationContext getApplicationContext()

Access the application context that the container 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 container itself.

Returns:

the applicationContext that the container was created from