org.apache.camel.impl.health

Class DefaultHealthCheckService

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.health.DefaultHealthCheckService

All Implemented Interfaces:

CamelContextAware, HealthCheckService, Service, ShutdownableService, StatefulService, SuspendableService

public final class DefaultHealthCheckService
extends ServiceSupport
implements HealthCheckService

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
DefaultHealthCheckService()
DefaultHealthCheckService(CamelContext camelContext)

Method Summary

Modifier and Type	Method and Description
void	addStateChangeListener(BiConsumer<HealthCheck.State,HealthCheck> consumer) Add a listener to invoke when the state of a check change.
Optional<HealthCheck.Result>	call(String id)
Optional<HealthCheck.Result>	call(String id, Map<String,Object> options) Invokes the check identified by the given id with the given options.
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
CamelContext	getCamelContext() Get the CamelContext
long	getCheckInterval()
TimeUnit	getCheckIntervalUnit()
HealthCheckRegistry	getHealthCheckRegistry()
Collection<HealthCheck.Result>	getResults() Return a list of the known checks status.
void	notify(HealthCheck check, HealthCheck.Result result) Notify the service that a check has changed status.
void	removeStateChangeListener(BiConsumer<HealthCheck.State,HealthCheck> consumer) Remove the state change listener.
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setCheckInterval(long checkInterval)
void	setCheckInterval(long interval, TimeUnit intervalUnit)
void	setCheckIntervalUnit(TimeUnit checkIntervalUnit)
void	setHealthCheckOptions(String id, Map<String,Object> options) Sets the options to be used when invoking the check identified by the given id.
void	setHealthCheckRegistry(HealthCheckRegistry registry)

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

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

unwrap

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

DefaultHealthCheckService

public DefaultHealthCheckService()

DefaultHealthCheckService

public DefaultHealthCheckService(CamelContext camelContext)

Method Detail

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

getHealthCheckRegistry

public HealthCheckRegistry getHealthCheckRegistry()

setHealthCheckRegistry

public void setHealthCheckRegistry(HealthCheckRegistry registry)

getCheckInterval

public long getCheckInterval()

setCheckInterval

public void setCheckInterval(long checkInterval)

setCheckInterval

public void setCheckInterval(long interval,
                             TimeUnit intervalUnit)

getCheckIntervalUnit

public TimeUnit getCheckIntervalUnit()

setCheckIntervalUnit

public void setCheckIntervalUnit(TimeUnit checkIntervalUnit)

addStateChangeListener

public void addStateChangeListener(BiConsumer<HealthCheck.State,HealthCheck> consumer)

Description copied from interface: HealthCheckService

Add a listener to invoke when the state of a check change.

Specified by:

addStateChangeListener in interface HealthCheckService

Parameters:

consumer - the event listener.

removeStateChangeListener

public void removeStateChangeListener(BiConsumer<HealthCheck.State,HealthCheck> consumer)

Description copied from interface: HealthCheckService

Remove the state change listener.

Specified by:

removeStateChangeListener in interface HealthCheckService

Parameters:

consumer - the event listener to remove.

setHealthCheckOptions

public void setHealthCheckOptions(String id,
                                  Map<String,Object> options)

Description copied from interface: HealthCheckService

Sets the options to be used when invoking the check identified by the given id.

Specified by:

setHealthCheckOptions in interface HealthCheckService

Parameters:

id - the health check id.

options - the health check options.

call

public Optional<HealthCheck.Result> call(String id)

Specified by:

call in interface HealthCheckService

Parameters:

id - the health check id.

Returns:

the result of the check or Optional.empty() if the id is unknown.

See Also:

#call(String, Map)}

call

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

Description copied from interface: HealthCheckService

Invokes the check identified by the given id with the given options.

Specified by:

call in interface HealthCheckService

Parameters:

id - the health check id.

options - the health check options.

Returns:

the result of the check or Optional.empty() if the id is unknown.

notify

public void notify(HealthCheck check,
                   HealthCheck.Result result)

Description copied from interface: HealthCheckService

Notify the service that a check has changed status. This may be useful for stateful checks like checks rely on tcp/ip connections.

Specified by:

notify in interface HealthCheckService

Parameters:

check - the health check.

result - the health check result.

getResults

public Collection<HealthCheck.Result> getResults()

Description copied from interface: HealthCheckService

Return a list of the known checks status.

Specified by:

getResults in interface HealthCheckService

Returns:

the list of results.

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Specified by:

doStart in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()