Class AvailabilityStateHealthIndicator

java.lang.Object

org.springframework.boot.health.contributor.AbstractHealthIndicator

org.springframework.boot.health.application.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:

4.0.0

Author:

Phillip Webb, Brian Clozel

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
<S extends AvailabilityState>	AvailabilityStateHealthIndicator(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 @Nullable AvailabilityState	getState(ApplicationAvailability applicationAvailability)	Return the current availability state.

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

AvailabilityStateHealthIndicator

public <S extends AvailabilityState> AvailabilityStateHealthIndicator(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 @Nullable AvailabilityState getState(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