Package org.springframework.boot.actuate.availability

Class AvailabilityStateHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator

All Implemented Interfaces:

HealthContributor, HealthIndicator

Direct Known Subclasses:

LivenessStateHealthIndicator, ReadinessStateHealthIndicator

public class AvailabilityStateHealthIndicator
extends AbstractHealthIndicator

A HealthIndicator that checks a specific AvailabilityState of the application.

Since:

2.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AvailabilityStateHealthIndicator.StatusMappings<S extends org.springframework.boot.availability.AvailabilityState>	Callback used to add status mappings.

Constructor Summary

Constructors

Constructor	Description
AvailabilityStateHealthIndicator(org.springframework.boot.availability.ApplicationAvailability applicationAvailability, Class<S> stateType, Consumer<AvailabilityStateHealthIndicator.StatusMappings<S>> statusMappings)	Create a new AvailabilityStateHealthIndicator instance.

Method Summary

Modifier and Type	Method	Description
protected void	doHealthCheck(Health.Builder builder)	Actual health check logic.
protected org.springframework.boot.availability.AvailabilityState	getState(org.springframework.boot.availability.ApplicationAvailability applicationAvailability)	Return the current availability state.

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

AvailabilityStateHealthIndicator

public AvailabilityStateHealthIndicator(org.springframework.boot.availability.ApplicationAvailability applicationAvailability,
 Class<S> stateType,
 Consumer<AvailabilityStateHealthIndicator.StatusMappings<S>> statusMappings)

Create a new AvailabilityStateHealthIndicator instance.

Type Parameters:

S - the availability state type

Parameters:

applicationAvailability - the application availability

stateType - the availability state type

statusMappings - consumer used to set up the status mappings

Method Details

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws Exception

Description copied from class: AbstractHealthIndicator

Actual health check logic.

Specified by:

doHealthCheck in class AbstractHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Throws:

Exception - any Exception that should create a Status.DOWN system status.

getState

protected org.springframework.boot.availability.AvailabilityState getState(org.springframework.boot.availability.ApplicationAvailability applicationAvailability)

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

Parameters:

applicationAvailability - the application availability

Returns:

the current availability state