com.cerner.beadledom.health

Class HealthDependency

java.lang.Object

com.cerner.beadledom.health.HealthDependency

public abstract class HealthDependency
extends Object

Represents a dependency to be checked during health checks.

HealthDependency instances must be thread-safe.

Constructor Summary

Constructors

Constructor and Description
HealthDependency()

Method Summary

Modifier and Type	Method and Description
abstract HealthStatus	checkAvailability() Invokes the dependency's basic availability health check (or closest equivalent).
Optional<String>	getBasicAvailabilityUrl() Deprecated. As of 2.1.1, no longer used in the display (html and json) of health endpoints.
Optional<String>	getDescription() Returns the description for the dependency or Optional.empty() if there is none.
abstract String	getName() Returns a short name for the dependency, which will be used to identify it in URLs.
Boolean	getPrimary() Returns a Boolean to indicate if this check is a primary check for this service.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthDependency

public HealthDependency()

Method Detail

checkAvailability

public abstract HealthStatus checkAvailability()

Invokes the dependency's basic availability health check (or closest equivalent).

Implementations may throw RuntimeExceptions; the health checker will handle them gracefully and assume the dependency is unhealthy.

Returns:

the status of the dependency

getBasicAvailabilityUrl

@Deprecated
public Optional<String> getBasicAvailabilityUrl()

Deprecated. As of 2.1.1, no longer used in the display (html and json) of health endpoints.

Return the URL to the basic availability health check (or closest equivalent) of the service, or Optional.empty() if there is none.

getPrimary

public Boolean getPrimary()

Returns a Boolean to indicate if this check is a primary check for this service.

getName

public abstract String getName()

Returns a short name for the dependency, which will be used to identify it in URLs.

Examples: "external-service", "hbase". This name must be unique amongst all the dependencies.

getDescription

public Optional<String> getDescription()

Returns the description for the dependency or Optional.empty() if there is none.