org.gytheio.health

Class Heartbeat

java.lang.Object

org.gytheio.health.Heartbeat

public class Heartbeat
extends Object

An object describing a properly behaving resource at a particular point in time.

Author:

Ray Gauss II

Constructor Summary

Constructors

Constructor and Description
Heartbeat()
Heartbeat(String componentId, String instanceId)
Heartbeat(String componentId, String instanceId, String status)

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentId() Gets the component identifier.
String	getInstanceId() Gets the identifier for a particular instance of a component such as an IP address.
String	getStatus() Gets the optional status message which might include additional statistics on health.
Long	getTime() Gets the epoch time of the health check.
void	setComponentId(String component) Sets the component identifier.
void	setInstanceId(String instanceId) Sets the identifier for a particular instance of a component.
void	setStatus(String status) Sets the optional status message which might include additional statistics on health.
void	setTime(Long time) Sets the epoch time of the health check.

Methods inherited from class java.lang.Object

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

Constructor Detail

Heartbeat

public Heartbeat()

Heartbeat

public Heartbeat(String componentId,
         String instanceId)

Heartbeat

public Heartbeat(String componentId,
         String instanceId,
         String status)

Method Detail

getComponentId

public String getComponentId()

Gets the component identifier.

Returns:

the component ID

setComponentId

public void setComponentId(String component)

Sets the component identifier.

Parameters:

component -

getInstanceId

public String getInstanceId()

Gets the identifier for a particular instance of a component such as an IP address.

Returns:

the component instance ID

setInstanceId

public void setInstanceId(String instanceId)

Sets the identifier for a particular instance of a component.

Parameters:

instanceId -

getTime

public Long getTime()

Gets the epoch time of the health check.

Returns:

the epoch time of the heartbeat

setTime

public void setTime(Long time)

Sets the epoch time of the health check.

Parameters:

time -

getStatus

public String getStatus()

Gets the optional status message which might include additional statistics on health.

Returns:

the status message

setStatus

public void setStatus(String status)

Sets the optional status message which might include additional statistics on health.

Parameters:

status -