```
public interface HealthCheck
```
A class that can return its health status
Applications can implement custom health checks and register them with the Coherence Management framework using Registry.register(HealthCheck).
Custom health checks, and built-in Coherence health checks will then appear as Coherence MBeans and can also be queried using the Coherence REST management and health APIs.

Since:

22.06

Author:

Jonathan Knight 2022.02.14

See Also:

Registry.register(HealthCheck), Registry.unregister(HealthCheck), Registry.getHealthChecks()

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`PATH_HEALTHZ`	The http request path for the healthz endpoint.
`static String`	`PATH_LIVE`	The http request path for the live endpoint.
`static String`	`PATH_READY`	The http request path for the ready endpoint.
`static String`	`PATH_SAFE`	The http request path for the safe endpoint.
`static String`	`PATH_STARTED`	The http request path for the started endpoint.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getName()`	Returns the unique name of this health check.
`boolean`	`isLive()`	Returns {@link true} if the resource represented by this `HealthCheck` is alive, otherwise returns `false`.
`default boolean`	`isMemberHealthCheck()`	Return `true` if this `HealthCheck` should be included when working out this Coherence member's health status.
`boolean`	`isReady()`	Returns {@link true} if the resource represented by this `HealthCheck` is ready, otherwise returns `false`.
`boolean`	`isSafe()`	Returns {@link true} if the resource represented by this `HealthCheck` is in a safe state to allow a rolling upgrade to proceed, otherwise returns `false`.
`boolean`	`isStarted()`	Returns {@link true} if the resource represented by this `HealthCheck` is started, otherwise returns `false`.

- Field Detail
  - PATH_READY
```
static final String PATH_READY
```
    The http request path for the ready endpoint.
    
    See Also:
    
    Constant Field Values
  - PATH_LIVE
```
static final String PATH_LIVE
```
    The http request path for the live endpoint.
    
    See Also:
    
    Constant Field Values
  - PATH_HEALTHZ
```
static final String PATH_HEALTHZ
```
    The http request path for the healthz endpoint.
    
    See Also:
    
    Constant Field Values
  - PATH_STARTED
```
static final String PATH_STARTED
```
    The http request path for the started endpoint.
    
    See Also:
    
    Constant Field Values
  - PATH_SAFE
```
static final String PATH_SAFE
```
    The http request path for the safe endpoint.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Returns the unique name of this health check.
    
    Returns:
    
    the unique name of this health check
  - isMemberHealthCheck
```
default boolean isMemberHealthCheck()
```
    Return true if this HealthCheck should be included when working out this Coherence member's health status.
    
    Returns:
    
    true if this HealthCheck should be included in the member's health status
  - isReady
```
boolean isReady()
```
    Returns {@link true} if the resource represented by this HealthCheck is ready, otherwise returns false.
    The concept of what "ready" means may vary for different types of resources.
    
    Returns:
    
    {@link true} if the resource represented by this HealthCheck is ready, otherwise false
  - isLive
```
boolean isLive()
```
    Returns {@link true} if the resource represented by this HealthCheck is alive, otherwise returns false.
    The concept of what "alive" means may vary for different types of resources.
    
    Returns:
    
    {@link true} if the resource represented by this HealthCheck is alive, otherwise returns false
  - isStarted
```
boolean isStarted()
```
    Returns {@link true} if the resource represented by this HealthCheck is started, otherwise returns false.
    The concept of what "started" means may vary for different types of resources.
    
    Returns:
    
    {@link true} if the resource represented by this HealthCheck is started, otherwise returns false
  - isSafe
```
boolean isSafe()
```
    Returns {@link true} if the resource represented by this HealthCheck is in a safe state to allow a rolling upgrade to proceed, otherwise returns false.
    The concept of what "safe" means may vary for different types of resources.
    
    Returns:
    
    {@link true} if the resource represented by this HealthCheck is in a safe state to allow a rolling upgrade to proceed, otherwise returns false

Interface HealthCheck

Field Summary

Method Summary

Field Detail

PATH_READY

PATH_LIVE

PATH_HEALTHZ

PATH_STARTED

PATH_SAFE

Method Detail

getName

isMemberHealthCheck

isReady

isLive

isStarted

isSafe