Package hec.jms

Class TSDataStored

java.lang.Object

hec.jms.GenericMessage

hec.jms.TSDataStored

public class TSDataStored
extends GenericMessage

Encapsulates a data exchange JMS message noting that data has been stored for a particular time series id.

  Properties                                            Comments
  Type  Name                    Value
  String        type                    TSDataStored
  long  millis                  varies  Creation time of message in milliseconds since 0000 01Jan1970 UTC
  String        ts_id                   varies  Time series ID of data that were stored
  long  start_time              varies  Start time of data stored in milliseconds since 0000 01Jan1970 UTC
  long  end_time                varies  End time of data stored in milliseconds since 0000 01Jan1970 UTC
  long  original_millis varies  Creation time of original message (replay message only)
  String        replay_id               varies  Request ID from relay_data_messages call (replay message only).
  Payload                                       empty
  Table 1. Structure of Time Series Data Stored operations message.
 

Nested Class Summary

Nested classes/interfaces inherited from class hec.jms.GenericMessage

GenericMessage.MessageDefinition

Constructor Summary

Constructors

Constructor	Description
TSDataStored(javax.jms.MapMessage message)

Method Summary

Modifier and Type	Method	Description
long	getEndTime()	Returns the end time of the data that was stored as a java long ms value.
long	getOriginalCreationTime()	Returns the creation time of the original message when this message is the result of a replay data messages.
String	getReplayId()	Returns the request id if this message is the result of a replay data messages call.
long	getStartTime()	Returns the start time of the data that was stored as a java long ms value.
String	getTsId()	Returns the time series id of that data that was stored.

Methods inherited from class hec.jms.GenericMessage

addClass, getBody, getClassSubType, getClassType, getCreationTime, getInt, getLong, getMap, getRequiredMapKeys, getString, getSubType, getType

Methods inherited from class java.lang.Object

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

Constructor Details

TSDataStored

public TSDataStored(javax.jms.MapMessage message)

Method Details

getTsId

public String getTsId()
               throws javax.jms.JMSException

Returns the time series id of that data that was stored.

Throws:

javax.jms.JMSException

getStartTime

public long getStartTime()
                  throws javax.jms.JMSException

Returns the start time of the data that was stored as a java long ms value.

Throws:

javax.jms.JMSException

getEndTime

public long getEndTime()
                throws javax.jms.JMSException

Returns the end time of the data that was stored as a java long ms value.

Throws:

javax.jms.JMSException

getOriginalCreationTime

public long getOriginalCreationTime()
                             throws javax.jms.JMSException

Returns the creation time of the original message when this message is the result of a replay data messages.

Throws:

javax.jms.JMSException

getReplayId

public String getReplayId()
                   throws javax.jms.JMSException

Returns the request id if this message is the result of a replay data messages call.

Throws:

javax.jms.JMSException