org.apache.camel.impl.health

Class AbstractHealthCheck

java.lang.Object

org.apache.camel.impl.health.AbstractHealthCheck

All Implemented Interfaces:

HealthCheck, Ordered, HasGroup, HasId

Direct Known Subclasses:

ContextHealthCheck, RouteHealthCheck

public abstract class AbstractHealthCheck
extends Object
implements HealthCheck

Nested Class Summary

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

HealthCheck.Result, 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)
HealthCheck.Result	call() Invoke the check.
HealthCheck.Result	call(Map<String,Object> options) Invoke the check.
protected abstract void	doCall(HealthCheckResultBuilder builder, Map<String,Object> options) Invoke the health check.
boolean	equals(Object o)
HealthCheckConfiguration	getConfiguration() Return the configuration associated with this HealthCheck.
String	getGroup() Returns the group
String	getId() Returns the id
Map<String,Object>	getMetaData() Return meta data associated with this HealthCheck.
int	hashCode()
void	setConfiguration(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

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()

Description copied from interface: HasId

Returns the id

Specified by:

getId in interface HasId

Returns:

the id

getGroup

public String getGroup()

Description copied from interface: HasGroup

Returns the group

Specified by:

getGroup in interface HasGroup

Returns:

the group

getMetaData

public Map<String,Object> getMetaData()

Description copied from interface: HealthCheck

Return meta data associated with this HealthCheck.

Specified by:

getMetaData in interface HealthCheck

getConfiguration

public HealthCheckConfiguration getConfiguration()

Description copied from interface: HealthCheck

Return the configuration associated with this HealthCheck.

Specified by:

getConfiguration in interface HealthCheck

setConfiguration

public void setConfiguration(HealthCheckConfiguration configuration)

call

public HealthCheck.Result call()

Description copied from interface: HealthCheck

Invoke the check.

Specified by:

call in interface HealthCheck

See Also:

#call(Map)}

call

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

Description copied from interface: HealthCheck

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.

Specified by:

call in interface 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(HealthCheckResultBuilder builder,
                               Map<String,Object> options)

Invoke the health check.

See Also:

HealthCheck#call(Map)}