spring-boot/org.springframework.boot.availability/ApplicationAvailability

ApplicationAvailability

interface ApplicationAvailability

Provides availability state information for the application.

Components can inject this class to get the current state information. To update the state of the application an AvailabilityChangeEvent should be published to the application context with directly or through publish.

Author

Brian Clozel

Phillip Webb

Since

2.3.0

Inheritors

Functions

Link copied to clipboard
abstract fun <S : AvailabilityState?> getLastChangeEvent(stateType: Class<S>): AvailabilityChangeEvent<S>
Return the last AvailabilityChangeEvent received for a given state type.
Link copied to clipboard
open fun getLivenessState(): LivenessState
Return the LivenessState of the application.
Link copied to clipboard
open fun getReadinessState(): ReadinessState
Return the ReadinessState of the application.
Link copied to clipboard
abstract fun <S : AvailabilityState?> getState(stateType: Class<S>): S
abstract fun <S : AvailabilityState?> getState(stateType: Class<S>, defaultState: S): S
Return AvailabilityState information for the application.