Package com.linecorp.armeria.server.healthcheck

Class SettableHealthChecker

java.lang.Object

com.linecorp.armeria.common.util.AbstractListenable<HealthChecker>

com.linecorp.armeria.server.healthcheck.SettableHealthChecker

All Implemented Interfaces:

Listenable<HealthChecker>, HealthChecker, ListenableHealthChecker

public final class SettableHealthChecker
extends AbstractListenable<HealthChecker>
implements ListenableHealthChecker

A simple ListenableHealthChecker whose state can be set by a caller. This can be used in case server health should have additional conditions besides the state of the Server. e.g. it should depend on the health of a backend.

Constructor Summary

Constructors

Constructor	Description
SettableHealthChecker()	Constructs a new SettableHealthChecker which starts out in a healthy state and can be changed using setHealthy(boolean).
SettableHealthChecker(boolean isHealthy)	Constructs a new SettableHealthChecker which starts out in the specified health state and can be changed using setHealthy(boolean).

Method Summary

Modifier and Type	Method	Description
boolean	isHealthy()	Returns true if and only if the Server is healthy.
protected HealthChecker	latestValue()	Returns the latest value notified before.
SettableHealthChecker	setHealthy(boolean isHealthy)	Sets if the Server is healthy or not.
String	toString()

Methods inherited from class com.linecorp.armeria.common.util.AbstractListenable

addListener, addListener, notifyListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.common.util.Listenable

addListener, removeListener

Constructor Details

SettableHealthChecker

public SettableHealthChecker()

Constructs a new SettableHealthChecker which starts out in a healthy state and can be changed using setHealthy(boolean).

SettableHealthChecker

public SettableHealthChecker(boolean isHealthy)

Constructs a new SettableHealthChecker which starts out in the specified health state and can be changed using setHealthy(boolean).

Method Details

isHealthy

public boolean isHealthy()

Description copied from interface: HealthChecker

Returns true if and only if the Server is healthy.

Specified by:

isHealthy in interface HealthChecker

setHealthy

public SettableHealthChecker setHealthy(boolean isHealthy)

Sets if the Server is healthy or not.

latestValue

@Nonnull
protected HealthChecker latestValue()

Description copied from class: AbstractListenable

Returns the latest value notified before. null if the value has not been initialized yet or the implementation of this class cannot cache it.

Overrides:

latestValue in class AbstractListenable<HealthChecker>

toString

public String toString()

Overrides:

toString in class Object