Package org.springframework.boot.actuate.availability

Class ReadinessStateHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator

org.springframework.boot.actuate.availability.ReadinessStateHealthIndicator

All Implemented Interfaces:

HealthContributor, HealthIndicator

public class ReadinessStateHealthIndicator
extends AvailabilityStateHealthIndicator

A HealthIndicator that checks the ReadinessState of the application.

Since:

2.3.0

Author:

Brian Clozel, Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator

AvailabilityStateHealthIndicator.StatusMappings<S extends AvailabilityState>

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 org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator

doHealthCheck

Methods inherited from class org.springframework.boot.actuate.health.AbstractHealthIndicator

health

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator

getHealth

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