Package org.certificateservices.messages.heartbeat

Class HeartBeatMessage

java.lang.Object

org.certificateservices.messages.heartbeat.HeartBeatMessage

public class HeartBeatMessage
extends java.lang.Object

Value object containing all the information about a receipt message.

Constructor Summary

Constructors

Constructor	Description
HeartBeatMessage(java.lang.String systemId, java.util.List<MonitoringPoint> monitoringPoints, HealthStatus overallStatus)	Default constructor for a heart beat message.

Method Summary

Modifier and Type	Method	Description
java.util.List<MonitoringPoint>	getMonitoringPoints()
HealthStatus	getOverallStatus()
java.lang.String	getSystemId()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartBeatMessage

public HeartBeatMessage(java.lang.String systemId,
                        java.util.List<MonitoringPoint> monitoringPoints,
                        HealthStatus overallStatus)
                 throws MessageContentException

Default constructor for a heart beat message.

Parameters:

systemId - the id of the system sending the heart beat, never null

monitoringPoints - a list of monitoring points in the heart beat, at least one message should exists

overallStatus - summary status of the system, never null.

Throws:

MessageContentException - if invalid parameters where sent to the constructor.

Method Detail

getSystemId

public java.lang.String getSystemId()

Returns:

the id of the system sending the heart beat, never null

getMonitoringPoints

public java.util.List<MonitoringPoint> getMonitoringPoints()

Returns:

the current set of monitoring point, never null.

getOverallStatus

public HealthStatus getOverallStatus()

Returns:

summary status of the system, never null.