Package org.apache.camel.health

Interface HealthCheck

All Superinterfaces:

HasGroup, HasId, Ordered

public interface HealthCheck
extends HasGroup, HasId, Ordered

Health check

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HealthCheck.Result	Response to an health check invocation.
static class	HealthCheck.State

Field Summary

Fields inherited from interface org.apache.camel.Ordered

HIGHEST, LOWEST

Method Summary

Modifier and Type	Method	Description
default HealthCheck.Result	call()	Invoke the check.
HealthCheck.Result	call(Map<String,Object> options)	Invoke the check.
HealthCheckConfiguration	getConfiguration()	Return the configuration associated with this HealthCheck.
default Map<String,Object>	getMetaData()	Return meta data associated with this HealthCheck.
default int	getOrder()	Gets the order.
default boolean	isLiveness()	Whether this health check can be used for liveness checks
default boolean	isReadiness()	Whether this health check can be used for readiness checks

Methods inherited from interface org.apache.camel.spi.HasGroup

getGroup

Methods inherited from interface org.apache.camel.spi.HasId

getId

Method Detail

getOrder

default int getOrder()

Description copied from interface: Ordered

Gets the order.

Use low numbers for higher priority. Normally the sorting will start from 0 and move upwards. So if you want to be last then use Integer.MAX_VALUE or eg Ordered.LOWEST.

Specified by:

getOrder in interface Ordered

Returns:

the order

getMetaData

default Map<String,Object> getMetaData()

Return meta data associated with this HealthCheck.

isReadiness

default boolean isReadiness()

Whether this health check can be used for readiness checks

isLiveness

default boolean isLiveness()

Whether this health check can be used for liveness checks

getConfiguration

HealthCheckConfiguration getConfiguration()

Return the configuration associated with this HealthCheck.

call

default HealthCheck.Result call()

Invoke the check.

See Also:

call(Map)

call

HealthCheck.Result call(Map<String,Object> options)

Invoke the check. The implementation is responsible to eventually perform the check according to the limitation of the third party system i.e. it should not be performed too often to avoid rate limiting. The options argument can be used to pass information specific to the check like forcing the check to be performed against the policies. The implementation is responsible to catch an handle any exception thrown by the underlying technology, including unchecked ones.