Package org.apache.camel.impl.health

Class AbstractHealthCheck

java.lang.Object

org.apache.camel.impl.health.AbstractHealthCheck

All Implemented Interfaces:

org.apache.camel.CamelContextAware, 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, org.apache.camel.CamelContextAware

Base implementation for HealthCheck.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_ERROR_CODE
static String	SERVICE_STATUS_CODE

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

CHECK_ENABLED, CHECK_GROUP, CHECK_ID, CHECK_KIND, ENDPOINT_URI, FAILURE_COUNT, FAILURE_ENDPOINT_URI, FAILURE_ERROR_COUNT, FAILURE_START_TIME, FAILURE_TIME, HTTP_RESPONSE_CODE, INVOCATION_ATTEMPT_TIME, INVOCATION_COUNT, INVOCATION_TIME, SUCCESS_COUNT, SUCCESS_START_TIME, SUCCESS_TIME

Fields inherited from interface org.apache.camel.Ordered

HIGHEST, LOWEST

Constructor Summary

Constructors

Modifier	Constructor	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	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 org.apache.camel.health.HealthCheckResultBuilder	doCall(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.CamelContext	getCamelContext()
String	getGroup()
String	getId()
Map<String,Object>	getMetaData()
int	hashCode()
boolean	isEnabled()
void	setCamelContext(org.apache.camel.CamelContext camelContext)
void	setEnabled(boolean enabled)

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

callLiveness, callReadiness, getOrder, isLiveness, isReadiness

Field Detail

SERVICE_STATUS_CODE

public static final String SERVICE_STATUS_CODE

See Also:

Constant Field Values

SERVICE_ERROR_CODE

public static final String SERVICE_ERROR_CODE

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

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.CamelContextAware

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

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

isEnabled

public boolean isEnabled()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Specified by:

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

getMetaData

public Map<String,Object> getMetaData()

Specified by:

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

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

doCall

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

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)