org.apache.camel.impl.health

Class AbstractHealthCheck

java.lang.Object

org.apache.camel.impl.health.AbstractHealthCheck

All Implemented Interfaces:

org.apache.camel.health.HealthCheck, org.apache.camel.Ordered, org.apache.camel.spi.HasGroup, org.apache.camel.spi.HasId

Direct Known Subclasses:

ContextHealthCheck, RouteHealthCheck

public abstract class AbstractHealthCheck
extends Object
implements org.apache.camel.health.HealthCheck

Base implementation for HealthCheck.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.health.HealthCheck

org.apache.camel.health.HealthCheck.Result, org.apache.camel.health.HealthCheck.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECK_ENABLED
static String	CHECK_GROUP
static String	CHECK_ID
static String	FAILURE_COUNT
static String	INVOCATION_ATTEMPT_TIME
static String	INVOCATION_COUNT
static String	INVOCATION_TIME

Fields inherited from interface org.apache.camel.Ordered

HIGHEST, LOWEST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHealthCheck(String id)
protected	AbstractHealthCheck(String group, String id)
protected	AbstractHealthCheck(String group, String id, Map<String,Object> meta)

Method Summary

Modifier and Type	Method and Description
protected void	addMetaData(String key, Object value)
org.apache.camel.health.HealthCheck.Result	call()
org.apache.camel.health.HealthCheck.Result	call(Map<String,Object> options)
protected abstract void	doCall(org.apache.camel.health.HealthCheckResultBuilder builder, Map<String,Object> options) Invoke the health check.
boolean	equals(Object o)
org.apache.camel.health.HealthCheckConfiguration	getConfiguration()
String	getGroup()
String	getId()
Map<String,Object>	getMetaData()
int	hashCode()
void	setConfiguration(org.apache.camel.health.HealthCheckConfiguration configuration)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.health.HealthCheck

getOrder, isLiveness, isReadiness

Field Detail

CHECK_ID

public static final String CHECK_ID

See Also:

Constant Field Values

CHECK_GROUP

public static final String CHECK_GROUP

See Also:

Constant Field Values

CHECK_ENABLED

public static final String CHECK_ENABLED

See Also:

Constant Field Values

INVOCATION_COUNT

public static final String INVOCATION_COUNT

See Also:

Constant Field Values

INVOCATION_TIME

public static final String INVOCATION_TIME

See Also:

Constant Field Values

INVOCATION_ATTEMPT_TIME

public static final String INVOCATION_ATTEMPT_TIME

See Also:

Constant Field Values

FAILURE_COUNT

public static final String FAILURE_COUNT

See Also:

Constant Field Values

Constructor Detail

AbstractHealthCheck

protected AbstractHealthCheck(String id)

AbstractHealthCheck

protected AbstractHealthCheck(String group,
                              String id)

AbstractHealthCheck

protected AbstractHealthCheck(String group,
                              String id,
                              Map<String,Object> meta)

Method Detail

getId

public String getId()

Specified by:

getId in interface org.apache.camel.spi.HasId

getGroup

public String getGroup()

Specified by:

getGroup in interface org.apache.camel.spi.HasGroup

getMetaData

public Map<String,Object> getMetaData()

Specified by:

getMetaData in interface org.apache.camel.health.HealthCheck

getConfiguration

public org.apache.camel.health.HealthCheckConfiguration getConfiguration()

Specified by:

getConfiguration in interface org.apache.camel.health.HealthCheck

setConfiguration

public void setConfiguration(org.apache.camel.health.HealthCheckConfiguration configuration)

call

public org.apache.camel.health.HealthCheck.Result call()

Specified by:

call in interface org.apache.camel.health.HealthCheck

call

public org.apache.camel.health.HealthCheck.Result call(Map<String,Object> options)

Specified by:

call in interface org.apache.camel.health.HealthCheck

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

addMetaData

protected final void addMetaData(String key,
                                 Object value)

doCall

protected abstract void doCall(org.apache.camel.health.HealthCheckResultBuilder builder,
                               Map<String,Object> options)

Invoke the health check.

See Also:

HealthCheck#call(Map)}