com.TersoSolutions.Jetstream.SDK.Application.Events

Class HeartbeatEvent

java.lang.Object

com.TersoSolutions.Jetstream.SDK.Application.Events.JetstreamEvent

com.TersoSolutions.Jetstream.SDK.Application.Events.HeartbeatEvent

public class HeartbeatEvent
extends JetstreamEvent

HeartbeatEvent is used to indicate that a device is still working properly and has internet connectivity. Each device will send a HeartbeatEvent regardless of any other events at the interval specified in it's HeartbeatInterval parameter. This class is a read only alias class for the Jetstream HeartbeatEvent object created by the JAXB class generator. This class is used to avoid class naming collisions with additional support for creating the object from xml strings and returning the original xml message.

Since:

1.2

Author:

Johnathon Ender

See Also:

JetstreamEvent

Constructor Summary

Constructors

Constructor and Description
HeartbeatEvent(java.lang.String xml) Creates a new HeartbeatEvent object from an xml string

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getEventId() Get the 'EventId' attribute value.
java.util.Date	getEventTime() Get the 'EventTime' attribute value.
java.lang.String	getLogicalDeviceId() Get the 'LogicalDeviceId' attribute value.
java.util.Date	getReceivedTime() Get the 'ReceivedTime' attribute value.

Methods inherited from class com.TersoSolutions.Jetstream.SDK.Application.Events.JetstreamEvent

getId, getSourceXML, getTime, getType, setId, setSource, setTime, setType

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartbeatEvent

public HeartbeatEvent(java.lang.String xml)

Creates a new HeartbeatEvent object from an xml string

Parameters:

xml - The xml string to be deserialized into an HeartbeatEvent object

Method Detail

getEventId

public java.lang.String getEventId()

Get the 'EventId' attribute value. A unique identifier for the Event

Returns:

value

getEventTime

public java.util.Date getEventTime()

Get the 'EventTime' attribute value. The ISO 8601 compliant UTC date and time (yyyy-mm-ddThh:mm:ssZ) that Jetstream received the message from the device

Returns:

value

getLogicalDeviceId

public java.lang.String getLogicalDeviceId()

Get the 'LogicalDeviceId' attribute value. The LogicalDeviceId assigned in AddLogicalDevice

Returns:

value

getReceivedTime

public java.util.Date getReceivedTime()

Get the 'ReceivedTime' attribute value. The ISO 8601 compliant UTC date and time (yyyy-mm-ddThh:mm:ssZ) that Jetstream received the message from the device

Returns:

value