HeartbeatGenerator

HeartbeatGenerator is a JMS message producer that periodically generates messages according to the predefined occurrence policies. It contains a list of Occurrence on the time sequence and name, etc. Each outgoing message has the name and the time signatures. These messages can be used to trigger other actions down the stream.

Apart from the common properties, there are many implementation specific properties for HeartbeatGenerator.
Property Name Data Type Requirement Description Examples
Heartbeat integer optional default interval in second to generate messages 30 (default: 60)
Occurrence list mandatory list of occurrences see example
where Occurrence lists all occurrences. Here is the schema for the Occurrence:
Property Name Data Type Requirement Description Examples
Name string mandatory name of the occurrence 5min
Heartbeat integer optional interval in second to generate messages 30 (default: 60)
TextMode integer optional flag to determine message family 0 (default: 1 for TextMessage)
OverflowOption integer optional flag for overflow option 0 (default: 1 for keep new)
StringProperty map optional to set properties see example
MessageBody String optional template for message body see example

Here is an example of HeartbeatGenerator:

{
  "Name": "rcvr_heartbeat",
  "ClassName": "org.qbroker.receiver.HeartbeatGenerator",
  "URI": "hb://localhost",
  "LinkName": "root",
  "Operation": "generate",
  "Heartbeat": "60",
  "DisplayMask": "0",
  "Mode": "daemon",
  "TextMode": "1",
  "XAMode": "1",
  "Occurrence": [{
    "Name": "test60",
    "Heartbeat": "60"
  },{
    "Name": "test90",
    "Heartbeat": "90"
  }]
}
where there are two groups of heartbeat. The hearbeat of the test60 is 60 sec. The hearbeat of the test90 is 90 sec.