org.opennms.netmgt.telemetry.config.model

Class Protocol

java.lang.Object

org.opennms.netmgt.telemetry.config.model.Protocol

All Implemented Interfaces:

Protocol

public class Protocol
extends Object
implements Protocol

Constructor Summary

Constructors

Constructor and Description
Protocol()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<Adapter>	getAdapters()
Optional<Integer>	getBatchIntervalMs() Messages are aggregated in batches before being dispatched.
Optional<Integer>	getBatchSize() Messages are aggregated in batches before being dispatched.
String	getDescription()
Boolean	getEnabled()
List<Listener>	getListeners()
String	getName() The name of the protocol.
Optional<Integer>	getNumThreads() Number of threads used for consuming/dispatching messages.
List<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.
int	hashCode()
void	setAdapters(List<Adapter> adapters)
void	setBatchIntervalMs(Integer batchIntervalMs)
void	setBatchSize(Integer batchSize)
void	setDescription(String description)
void	setEnabled(Boolean enabled)
void	setListeners(List<Listener> listeners)
void	setName(String name)
void	setNumThreads(Integer numThreads)
void	setPackages(List<Package> packages)
void	setQueueSize(Integer queueSize)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Protocol

public Protocol()

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

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getEnabled

public Boolean getEnabled()

setEnabled

public void setEnabled(Boolean enabled)

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

setNumThreads

public void setNumThreads(Integer numThreads)

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

setBatchSize

public void setBatchSize(Integer batchSize)

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

setBatchIntervalMs

public void setBatchIntervalMs(Integer batchIntervalMs)

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

setQueueSize

public void setQueueSize(Integer queueSize)

getListeners

public List<Listener> getListeners()

setListeners

public void setListeners(List<Listener> listeners)

getAdapters

public List<Adapter> getAdapters()

setAdapters

public void setAdapters(List<Adapter> adapters)

getPackages

public List<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

setPackages

public void setPackages(List<Package> packages)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object