org.springframework.boot.actuate.availability

类 AvailabilityStateHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator

所有已实现的接口:

HealthContributor, HealthIndicator

直接已知子类:

LivenessStateHealthIndicator, ReadinessStateHealthIndicator

public class AvailabilityStateHealthIndicator
extends AbstractHealthIndicator

A HealthIndicator that checks a specific AvailabilityState of the application.

从以下版本开始:

2.3.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	AvailabilityStateHealthIndicator.StatusMappings<S extends org.springframework.boot.availability.AvailabilityState> Callback used to add status mappings.

构造器概要

构造器

构造器和说明
AvailabilityStateHealthIndicator(org.springframework.boot.availability.ApplicationAvailability applicationAvailability, java.lang.Class<S> stateType, java.util.function.Consumer<AvailabilityStateHealthIndicator.StatusMappings<S>> statusMappings) Create a new AvailabilityStateHealthIndicator instance.

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 org.springframework.boot.actuate.health.AbstractHealthIndicator

health

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.springframework.boot.actuate.health.HealthIndicator

getHealth

构造器详细资料

AvailabilityStateHealthIndicator

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

Create a new AvailabilityStateHealthIndicator instance.

类型参数:

S - the availability state type

参数:

applicationAvailability - the application availability

stateType - the availability state type

statusMappings - consumer used to set up the status mappings

方法详细资料

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws java.lang.Exception

从类复制的说明: AbstractHealthIndicator

Actual health check logic.

指定者:

doHealthCheck 在类中 AbstractHealthIndicator

参数:

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

抛出:

java.lang.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.

参数:

applicationAvailability - the application availability

返回:

the current availability state