Package org.apache.camel.health

Class HealthCheckHelper

java.lang.Object

org.apache.camel.health.HealthCheckHelper

public final class HealthCheckHelper
extends Object

Helper for invoking HealthCheck's. The helper will lookup the HealthCheckRegistry from CamelContext and gather all the registered HealthChecks and invoke them and gather their responses. The helper allows filtering out unwanted health checks using HealthCheckFilter or to invoke only readiness or liveness checks.

Method Summary

Modifier and Type	Method	Description
static String	getGroup(HealthCheck check)	Get the group of the given check or an empty string if the group is not set.
static Collection<HealthCheck.Result>	invoke(CamelContext camelContext)	Invokes the checks and returns a collection of results.
static Optional<HealthCheck.Result>	invoke(CamelContext camelContext, String id, Map<String,Object> options)	Invoke a check by id.
static Collection<HealthCheck.Result>	invoke(CamelContext camelContext, Function<HealthCheck,Map<String,Object>> optionsSupplier)	Invokes the checks and returns a collection of results.
static Collection<HealthCheck.Result>	invoke(CamelContext camelContext, Function<HealthCheck,Map<String,Object>> optionsSupplier, HealthCheckFilter filter)	Invokes the checks and returns a collection of results.
static Collection<HealthCheck.Result>	invoke(CamelContext camelContext, HealthCheckFilter filter)	Invokes the checks and returns a collection of results.
static Collection<HealthCheck.Result>	invokeLiveness(CamelContext camelContext)	Invokes the liveness checks and returns a collection of results.
static Collection<HealthCheck.Result>	invokeReadiness(CamelContext camelContext)	Invokes the readiness checks and returns a collection of results.
static Optional<HealthCheck.Result>	query(CamelContext camelContext, String id, Map<String,Object> options)	Query the status of a check by id.

Methods inherited from class java.lang.Object

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

Method Detail

getGroup

public static String getGroup(HealthCheck check)

Get the group of the given check or an empty string if the group is not set.

Parameters:

check - the health check

Returns:

the HasGroup.getGroup() or an empty string if it is null

invoke

public static Collection<HealthCheck.Result> invoke(CamelContext camelContext)

Invokes the checks and returns a collection of results.

invokeReadiness

public static Collection<HealthCheck.Result> invokeReadiness(CamelContext camelContext)

Invokes the readiness checks and returns a collection of results.

invokeLiveness

public static Collection<HealthCheck.Result> invokeLiveness(CamelContext camelContext)

Invokes the liveness checks and returns a collection of results.

invoke

public static Collection<HealthCheck.Result> invoke(CamelContext camelContext,
                                                    Function<HealthCheck,Map<String,Object>> optionsSupplier)

Invokes the checks and returns a collection of results.

invoke

public static Collection<HealthCheck.Result> invoke(CamelContext camelContext,
                                                    HealthCheckFilter filter)

Invokes the checks and returns a collection of results.

invoke

public static Collection<HealthCheck.Result> invoke(CamelContext camelContext,
                                                    Function<HealthCheck,Map<String,Object>> optionsSupplier,
                                                    HealthCheckFilter filter)

Invokes the checks and returns a collection of results.

Parameters:

camelContext - the camel context.

optionsSupplier - a supplier for options.

filter - filter to exclude some checks.

query

public static Optional<HealthCheck.Result> query(CamelContext camelContext,
                                                 String id,
                                                 Map<String,Object> options)

Query the status of a check by id. Note that this may result in an effective invocation of the HealthCheck.

Parameters:

camelContext - the camel context.

id - the check id.

options - the check options.

Returns:

an optional HealthCheck.Result.

invoke

public static Optional<HealthCheck.Result> invoke(CamelContext camelContext,
                                                  String id,
                                                  Map<String,Object> options)

Invoke a check by id.

Parameters:

camelContext - the camel context.

id - the check id.

options - the check options.

Returns:

an optional HealthCheck.Result.