org.opennms.netmgt.telemetry.distributed.common

Class MapBasedProtocolDef

java.lang.Object

org.opennms.netmgt.telemetry.distributed.common.MapBasedProtocolDef

All Implemented Interfaces:

Protocol

public class MapBasedProtocolDef
extends Object
implements Protocol

Constructor Summary

Constructors

Constructor and Description
MapBasedProtocolDef(Map<String,String> parameters)

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	getBatchIntervalMs() Messages are aggregated in batches before being dispatched.
Optional<Integer>	getBatchSize() Messages are aggregated in batches before being dispatched.
String	getName() The name of the protocol.
Optional<Integer>	getNumThreads() Number of threads used for consuming/dispatching messages.
List<? extends Package>	getPackages() Packages may contain settings for specific sources.
Optional<Integer>	getQueueSize() Maximum number of messages to keep in memory while waiting to be dispatched.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBasedProtocolDef

public MapBasedProtocolDef(Map<String,String> parameters)

Method Detail

getName

public String getName()

Description copied from interface: Protocol

The name of the protocol. This is used as a suffix for any associated queues that are created and must be the same on both OpenNMS and Minion.

Specified by:

getName in interface Protocol

Returns:

the protocol name

getNumThreads

public Optional<Integer> getNumThreads()

Description copied from interface: Protocol

Number of threads used for consuming/dispatching messages.

Specified by:

getNumThreads in interface Protocol

Returns:

the number of threads

getBatchSize

public Optional<Integer> getBatchSize()

Description copied from interface: Protocol

Messages are aggregated in batches before being dispatched. When the batch reaches this size, it will be dispatched.

Specified by:

getBatchSize in interface Protocol

Returns:

the batch size

getBatchIntervalMs

public Optional<Integer> getBatchIntervalMs()

Description copied from interface: Protocol

Messages are aggregated in batches before being dispatched. When the batch has been created for longer than this interval (ms) it will be dispatched, regardless of the current size.

Specified by:

getBatchIntervalMs in interface Protocol

Returns:

the batch interval

getQueueSize

public Optional<Integer> getQueueSize()

Description copied from interface: Protocol

Maximum number of messages to keep in memory while waiting to be dispatched.

Specified by:

getQueueSize in interface Protocol

Returns:

the queue size

getPackages

public List<? extends Package> getPackages()

Description copied from interface: Protocol

Packages may contain settings for specific sources.

Specified by:

getPackages in interface Protocol

Returns:

the list of configured packages