org.gytheio.health.heartbeat

Class Heartbeat

java.lang.Object

org.gytheio.health.heartbeat.Heartbeat

public class Heartbeat
extends Object

An object describing service resource behavior at a particular point in time.

Author:

Ray Gauss II

Constructor Summary

Constructors

Constructor and Description
Heartbeat()
Heartbeat(String serviceType, String serviceInstanceId, boolean isAvailable)
Heartbeat(String serviceType, String serviceInstanceId, boolean isAvailable, Map<String,String> detail)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getDetails() Gets the optional status details which might include additional statistics on health.
String	getServiceInstanceId() Gets the identifier for a particular instance of a service such as an IP address.
String	getServiceType() Gets the service type.
Long	getTimestamp() Gets the epoch time of the health check.
boolean	isAvailable() Gets whether or not the component is available
void	setAvailable(boolean isAvailable) Sets whether or not the component is available
void	setDetails(Map<String,String> detail) Sets the optional status details which might include additional statistics on health.
void	setServiceInstanceId(String serviceInstanceId) Sets the identifier for a particular instance of a component.
void	setServiceType(String serviceType) Sets the service type.
void	setTimestamp(Long timestamp) 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 serviceType,
         String serviceInstanceId,
         boolean isAvailable)

Heartbeat

public Heartbeat(String serviceType,
         String serviceInstanceId,
         boolean isAvailable,
         Map<String,String> detail)

Method Detail

getServiceType

public String getServiceType()

Gets the service type.

Returns:

the service type

setServiceType

public void setServiceType(String serviceType)

Sets the service type.

Parameters:

serviceType -

getServiceInstanceId

public String getServiceInstanceId()

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

Returns:

the service instance ID

setServiceInstanceId

public void setServiceInstanceId(String serviceInstanceId)

Sets the identifier for a particular instance of a component.

Parameters:

serviceInstanceId -

getTimestamp

public Long getTimestamp()

Gets the epoch time of the health check.

Returns:

the epoch time of the heartbeat

setTimestamp

public void setTimestamp(Long timestamp)

Sets the epoch time of the health check.

Parameters:

time -

isAvailable

public boolean isAvailable()

Gets whether or not the component is available

Returns:

true if available

setAvailable

public void setAvailable(boolean isAvailable)

Sets whether or not the component is available

Parameters:

isAvailable -

getDetails

public Map<String,String> getDetails()

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

Returns:

the status message

setDetails

public void setDetails(Map<String,String> detail)

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

Parameters:

detail -