org.springframework.boot.context.event

Class ApplicationReadyEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.boot.context.event.SpringApplicationEvent

org.springframework.boot.context.event.ApplicationReadyEvent

All Implemented Interfaces:

Serializable

public class ApplicationReadyEvent
extends SpringApplicationEvent

Event published as late as conceivably possible to indicate that the application is ready to service requests. The source of the event is the SpringApplication itself, but beware of modifying its internal state since all initialization steps will have been completed by then.

Since:

1.3.0

Author:

Stephane Nicoll, Chris Bono

See Also:

ApplicationFailedEvent, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ApplicationReadyEvent(SpringApplication application, String[] args, ConfigurableApplicationContext context) Deprecated. since 2.6.0 for removal in 2.8.0 in favor of ApplicationReadyEvent(SpringApplication, String[], ConfigurableApplicationContext, Duration)
ApplicationReadyEvent(SpringApplication application, String[] args, ConfigurableApplicationContext context, Duration timeTaken) Create a new ApplicationReadyEvent instance.

Method Summary

Modifier and Type	Method and Description
ConfigurableApplicationContext	getApplicationContext() Return the application context.
Duration	getTimeTaken() Return the time taken for the application to be ready to service requests, or null if unknown.

Methods inherited from class org.springframework.boot.context.event.SpringApplicationEvent

getArgs, getSpringApplication

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationReadyEvent

@Deprecated
public ApplicationReadyEvent(SpringApplication application,
                                         String[] args,
                                         ConfigurableApplicationContext context)

Deprecated. since 2.6.0 for removal in 2.8.0 in favor of ApplicationReadyEvent(SpringApplication, String[], ConfigurableApplicationContext, Duration)

Create a new ApplicationReadyEvent instance.

Parameters:

application - the current application

args - the arguments the application is running with

context - the context that was being created

ApplicationReadyEvent

public ApplicationReadyEvent(SpringApplication application,
                             String[] args,
                             ConfigurableApplicationContext context,
                             Duration timeTaken)

Create a new ApplicationReadyEvent instance.

Parameters:

application - the current application

args - the arguments the application is running with

context - the context that was being created

timeTaken - the time taken to get the application ready to service requests

Since:

2.6.0

Method Detail

getApplicationContext

public ConfigurableApplicationContext getApplicationContext()

Return the application context.

Returns:

the context

getTimeTaken

public Duration getTimeTaken()

Return the time taken for the application to be ready to service requests, or null if unknown.

Returns:

the time taken to be ready to service requests

Since:

2.6.0