org.springframework.boot.availability

Class ApplicationAvailabilityProvider

java.lang.Object

org.springframework.boot.availability.ApplicationAvailabilityProvider

All Implemented Interfaces:

EventListener, ApplicationListener<ApplicationEvent>

public class ApplicationAvailabilityProvider
extends Object
implements ApplicationListener<ApplicationEvent>

Holds the availability state of the application.

Other application components can get the current state information from the ApplicationAvailabilityProvider, or publish application evens such as ReadinessStateChangedEvent and LivenessStateChangedEvent to update the state of the application.

Since:

2.3.0

Author:

Brian Clozel

Constructor Summary

Constructors

Constructor and Description
ApplicationAvailabilityProvider() Create a new ApplicationAvailabilityProvider instance with LivenessState.BROKEN and ReadinessState.UNREADY.
ApplicationAvailabilityProvider(LivenessState livenessState, ReadinessState readinessState) Create a new ApplicationAvailabilityProvider with the given states.

Method Summary

Modifier and Type	Method and Description
LivenessState	getLivenessState() Return the LivenessState of the application.
ReadinessState	getReadinessState() Return the ReadinessState of the application.
void	onApplicationEvent(ApplicationEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationAvailabilityProvider

public ApplicationAvailabilityProvider()

Create a new ApplicationAvailabilityProvider instance with LivenessState.BROKEN and ReadinessState.UNREADY.

ApplicationAvailabilityProvider

public ApplicationAvailabilityProvider(LivenessState livenessState,
                                       ReadinessState readinessState)

Create a new ApplicationAvailabilityProvider with the given states.

Parameters:

livenessState - the liveness state

readinessState - the readiness state

Method Detail

getLivenessState

public LivenessState getLivenessState()

Return the LivenessState of the application.

Returns:

the liveness state

getReadinessState

public ReadinessState getReadinessState()

Return the ReadinessState of the application.

Returns:

the readiness state

onApplicationEvent

public void onApplicationEvent(ApplicationEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ApplicationEvent>