Package org.certificateservices.messages.heartbeat

Class MonitoringPoint

java.lang.Object

org.certificateservices.messages.heartbeat.MonitoringPoint

public class MonitoringPoint
extends java.lang.Object

Value object of a monitored object, indicating it's status and optional descriptive message.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MONITORING_POINT_ID_OVERALL_HEALTH

Constructor Summary

Constructors

Constructor	Description
MonitoringPoint(java.lang.String monitoringPointId, java.util.Date timestamp, HealthStatus status)	Minimal constructor containing all required parameters.
MonitoringPoint(java.lang.String monitoringPointId, java.util.Date timestamp, HealthStatus status, java.lang.String description)	Constuctor containing a descriptive message about the monitoring point.
MonitoringPoint(java.lang.String monitoringPointId, java.util.Date timestamp, HealthStatus status, java.lang.String description, java.lang.Long currentThroughput, java.lang.Long maxThroughput, java.lang.String throughputUnits)	Constuctor containing optional throughput data about the monitoring point.

Method Summary

Modifier and Type	Method	Description
java.lang.Long	getCurrentThroughput()
java.lang.String	getDescription()
java.lang.Long	getMaxThroughput()
java.lang.String	getMonitoringPointId()
HealthStatus	getStatus()
java.lang.String	getThroughputUnits()
java.util.Date	getTimestamp()

Methods inherited from class java.lang.Object

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

Field Detail

MONITORING_POINT_ID_OVERALL_HEALTH

public static java.lang.String MONITORING_POINT_ID_OVERALL_HEALTH

Constructor Detail

MonitoringPoint

public MonitoringPoint(java.lang.String monitoringPointId,
                       java.util.Date timestamp,
                       HealthStatus status)
                throws MessageContentException

Minimal constructor containing all required parameters.

Parameters:

monitoringPointId - id of the monitoring point in the system, never null or empty.

timestamp - time stamp of when the monitoring occurred, never null.

status - the current status of the monitoring point, never null.

Throws:

java.lang.IllegalArgumentException - if constructor parameters contained invalid data.

MessageContentException

MonitoringPoint

public MonitoringPoint(java.lang.String monitoringPointId,
                       java.util.Date timestamp,
                       HealthStatus status,
                       java.lang.String description)
                throws MessageContentException

Constuctor containing a descriptive message about the monitoring point.

Parameters:

monitoringPointId - id of the monitoring point in the system, never null or empty.

timestamp - time stamp of when the monitoring occurred, never null.

status - the current status of the monitoring point, never null.

description - optional description of the statue of the monitoring point, can be null.

Throws:

java.lang.IllegalArgumentException - if constructor parameters contained invalid data.

MessageContentException

MonitoringPoint

public MonitoringPoint(java.lang.String monitoringPointId,
                       java.util.Date timestamp,
                       HealthStatus status,
                       java.lang.String description,
                       java.lang.Long currentThroughput,
                       java.lang.Long maxThroughput,
                       java.lang.String throughputUnits)
                throws MessageContentException

Constuctor containing optional throughput data about the monitoring point.

Parameters:

monitoringPointId - id of the monitoring point in the system, never null or empty.

timestamp - time stamp of when the monitoring occurred, never null.

status - the current status of the monitoring point, never null.

description - optional description of the statue of the monitoring point, can be null.

currentThroughput - optional current throughput of the given monitoring point, can be null if not applicable.

maxThroughput - optional estimated maximum throughput of the given monitoring point, can be null if not applicable.

throughputUnits - optional string containing the units to display when showing the throughput, can be null if not applicable.

Throws:

java.lang.IllegalArgumentException - if constructor parameters contained invalid data.

MessageContentException

Method Detail

getMonitoringPointId

public java.lang.String getMonitoringPointId()

Returns:

id of the monitoring point in the system, never null or empty.

getTimestamp

public java.util.Date getTimestamp()

Returns:

time stamp of when the monitoring occurred, never null.

getStatus

public HealthStatus getStatus()

Returns:

the current status of the monitoring point, never null.

getDescription

public java.lang.String getDescription()

Returns:

optional description of the statue of the monitoring point, can be null.

getCurrentThroughput

public java.lang.Long getCurrentThroughput()

Returns:

optional current throughput of the given monitoring point, can be null if not applicable.

getMaxThroughput

public java.lang.Long getMaxThroughput()

Returns:

optional estimated maximum throughput of the given monitoring point, can be null if not applicable.

getThroughputUnits

public java.lang.String getThroughputUnits()

Returns:

optional string containing the units to display when showing the throughput, can be null if not applicable.