io.stargate.db.datastore.common.util

Class HealthCheckWithGracePeriod

java.lang.Object

io.stargate.db.datastore.common.util.HealthCheckWithGracePeriod

Direct Known Subclasses:

SchemaAgreementAchievableCheck

public abstract class HealthCheckWithGracePeriod
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Duration	gracePeriod

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HealthCheckWithGracePeriod(Duration gracePeriod, TimeSource timeSource)

Method Summary

Modifier and Type	Method and Description
boolean	check() Executes the logic for determining whether the system is in a healthy state and returns the result.
protected abstract boolean	isHealthy() Executes the specific logic for determining whether the system is in a healthy state.
protected void	reset() Resets the grace period marker.

Methods inherited from class java.lang.Object

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

Field Detail

gracePeriod

protected final Duration gracePeriod

Constructor Detail

HealthCheckWithGracePeriod

protected HealthCheckWithGracePeriod(Duration gracePeriod,
                                     TimeSource timeSource)

Method Detail

isHealthy

protected abstract boolean isHealthy()

Executes the specific logic for determining whether the system is in a healthy state. This method need not deal with the grace period, which is handled by check().

Returns:

true if the system is healthy, false otherwise.

reset

protected void reset()

Resets the grace period marker. A new grace period will begin at the next failed health check.

check

public boolean check()

Executes the logic for determining whether the system is in a healthy state and returns the result.

Actual health checks are performed by isHealthy(), this method additionally applies the grace period (as set in the constructor) to failed checks.

Returns:

true if the system is healthy, false otherwise.