HeartbeatModule (OpenNMS 2022.1.1 API)

java.lang.Object
- org.opennms.core.ipc.sink.xml.AbstractXmlSinkModule<MinionIdentityDTO,MinionIdentityDTO>
- - org.opennms.minion.heartbeat.common.HeartbeatModule

All Implemented Interfaces:: SinkModule<MinionIdentityDTO,MinionIdentityDTO>

public class HeartbeatModule
extends AbstractXmlSinkModule<MinionIdentityDTO,MinionIdentityDTO>

Field Summary

Fields
Modifier and Type Field Description

static String MODULE_ID
- Fields inherited from interface org.opennms.core.ipc.sink.api.SinkModule
  HEARTBEAT_MODULE_ID

Constructor Summary

Constructors
Constructor Description

HeartbeatModule()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AggregationPolicy<MinionIdentityDTO,MinionIdentityDTO,MinionIdentityDTO>`	`getAggregationPolicy()`	Defines how messages should be combined, and when they should be "released".
`AsyncPolicy`	`getAsyncPolicy()`	Defines how messages should be asynchronously dispatched.
`String`	`getId()`	Globally unique identifier.
`int`	`getNumConsumerThreads()`	The number of threads used to consume from the broker.

Methods inherited from class org.opennms.core.ipc.sink.xml.AbstractXmlSinkModule
equals, hashCode, marshal, marshalSingleMessage, unmarshal, unmarshalSingleMessage

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opennms.core.ipc.sink.api.SinkModule
getRoutingKey

- Field Detail
  - MODULE_ID
```
public static final String MODULE_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HeartbeatModule
```
public HeartbeatModule()
```
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: SinkModule
    
    Globally unique identifier. Used in the JMS queue name in the Camel implementation.
  - getNumConsumerThreads
```
public int getNumConsumerThreads()
```
    Description copied from interface: SinkModule
    
    The number of threads used to consume from the broker.
  - getAggregationPolicy
```
public AggregationPolicy<MinionIdentityDTO,MinionIdentityDTO,MinionIdentityDTO> getAggregationPolicy()
```
    Description copied from interface: SinkModule
    
    Defines how messages should be combined, and when they should be "released". Modules that do not wish to use aggregation can return null.
    
    Returns:
    
    the AggregationPolicy used to combine messages, or null if the messages should not be combined.
  - getAsyncPolicy
```
public AsyncPolicy getAsyncPolicy()
```
    Description copied from interface: SinkModule
    
    Defines how messages should be asynchronously dispatched.
    
    Returns:
    
    the AsyncPolicy used when asynchronously dispatching messages for this module.