org.gytheio.health.heartbeat

Class AbstractHeartImpl

java.lang.Object

org.gytheio.health.heartbeat.AbstractHeartImpl

All Implemented Interfaces:

Heart

public abstract class AbstractHeartImpl
extends Object
implements Heart

Abstract heart implementation for sending Heartbeat messages.

Author:

Ray Gauss II

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractHeartImpl.HeartbeatTask

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	DEFAULT_TIMER_DELAY_MS
protected static long	DEFAULT_TIMER_PERIOD_MS
static Object	SERVICE_INSTANCE_ID_FLAG_GENERATE_UUID
protected String	serviceInstanceId
protected String	serviceType
protected Timer	timer
protected long	timerPeriodMs

Constructor Summary

Constructors

Constructor and Description
AbstractHeartImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Heartbeat	beat() Returns a single Heartbeat object without sending via messaging
protected abstract Map<String,String>	gatherDetails() Gathers any useful health metrics for the details section of each heartbeat messages.
protected abstract void	send(Heartbeat heartbeat) Sends the given heartbeat message
void	setServiceInstanceId(String serviceInstanceId) Sets the service instance ID to be used for Heartbeat messages.
void	setServiceType(String serviceType) Sets the service type to be used for Heartbeat messages.
void	setTimerPeriodMs(long timerPeriodMs) The period of heartbeat messages
void	start() Starts the repeated sending of Heartbeat messages for health monitoring
void	stop() Stops the repeated sending of Heartbeat messages for health monitoring

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_INSTANCE_ID_FLAG_GENERATE_UUID

public static final Object SERVICE_INSTANCE_ID_FLAG_GENERATE_UUID

DEFAULT_TIMER_DELAY_MS

protected static final long DEFAULT_TIMER_DELAY_MS

See Also:

Constant Field Values

DEFAULT_TIMER_PERIOD_MS

protected static final long DEFAULT_TIMER_PERIOD_MS

See Also:

Constant Field Values

serviceType

protected String serviceType

serviceInstanceId

protected String serviceInstanceId

timer

protected Timer timer

timerPeriodMs

protected long timerPeriodMs

Constructor Detail

AbstractHeartImpl

public AbstractHeartImpl()

Method Detail

setServiceType

public void setServiceType(String serviceType)

Sets the service type to be used for Heartbeat messages.

Parameters:

serviceType -

setServiceInstanceId

public void setServiceInstanceId(String serviceInstanceId)

Sets the service instance ID to be used for Heartbeat messages.

Parameters:

serviceInstanceId -

setTimerPeriodMs

public void setTimerPeriodMs(long timerPeriodMs)

The period of heartbeat messages

Parameters:

timerPeriodMs -

start

public void start()

Description copied from interface: Heart

Starts the repeated sending of Heartbeat messages for health monitoring

Specified by:

start in interface Heart

stop

public void stop()

Description copied from interface: Heart

Stops the repeated sending of Heartbeat messages for health monitoring

Specified by:

stop in interface Heart

beat

public Heartbeat beat()

Description copied from interface: Heart

Returns a single Heartbeat object without sending via messaging

Specified by:

beat in interface Heart

Returns:

the heartbeat object

gatherDetails

protected abstract Map<String,String> gatherDetails()

Gathers any useful health metrics for the details section of each heartbeat messages.

Returns:

the status details

send

protected abstract void send(Heartbeat heartbeat)

Sends the given heartbeat message

Parameters:

heartbeat -