Class ReadinessStateHealthIndicator

java.lang.Object

org.springframework.boot.health.contributor.AbstractHealthIndicator

org.springframework.boot.health.application.AvailabilityStateHealthIndicator

org.springframework.boot.health.application.ReadinessStateHealthIndicator

All Implemented Interfaces:

HealthContributor, HealthIndicator

public class ReadinessStateHealthIndicator
extends AvailabilityStateHealthIndicator

A HealthIndicator that checks the ReadinessState of the application.

Since:

4.0.0

Author:

Brian Clozel, Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class AvailabilityStateHealthIndicator

AvailabilityStateHealthIndicator.StatusMappings<S>

Constructor Summary

Constructors

Constructor	Description
ReadinessStateHealthIndicator(ApplicationAvailability availability)

Method Summary

Modifier and Type	Method	Description
protected AvailabilityState	getState(ApplicationAvailability applicationAvailability)	Return the current availability state.

Methods inherited from class AvailabilityStateHealthIndicator

doHealthCheck

Methods inherited from class AbstractHealthIndicator

health

Methods inherited from class Object

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

Methods inherited from interface HealthIndicator

health

Constructor Details

ReadinessStateHealthIndicator

public ReadinessStateHealthIndicator(ApplicationAvailability availability)

Method Details

getState

protected AvailabilityState getState(ApplicationAvailability applicationAvailability)

Description copied from class: AvailabilityStateHealthIndicator

Return the current availability state. Subclasses can override this method if a different retrieval mechanism is needed.

Overrides:

getState in class AvailabilityStateHealthIndicator

Parameters:

applicationAvailability - the application availability

Returns:

the current availability state