org.opennms.netmgt.telemetry.adapters.collection

Class AbstractPersistingAdapter

java.lang.Object

org.opennms.netmgt.telemetry.adapters.collection.AbstractPersistingAdapter

All Implemented Interfaces:

Adapter

Direct Known Subclasses:

JtiGpbAdapter

public abstract class AbstractPersistingAdapter
extends Object
implements Adapter

Constructor Summary

Constructors

Constructor and Description
AbstractPersistingAdapter()

Method Summary

Modifier and Type	Method and Description
abstract Optional<CollectionSetWithAgent>	handleMessage(TelemetryMessageDTO message, TelemetryMessageLogDTO messageLog) Build a collection set from the given message.
void	handleMessageLog(TelemetryMessageLogDTO messageLog) Handle the messages.
void	setProtocol(Protocol protocol) A single instance of an adapter will only be responsible for one protocol.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPersistingAdapter

public AbstractPersistingAdapter()

Method Detail

handleMessage

public abstract Optional<CollectionSetWithAgent> handleMessage(TelemetryMessageDTO message,
                                                               TelemetryMessageLogDTO messageLog)
                                                        throws Exception

Build a collection set from the given message. The message log is also provided in case the log contains additional meta-data required. IMPORTANT: Implementations of this method must be thread-safe.

Parameters:

message - message to be converted into a collection set

messageLog - message log to which the message belongs

Returns:

a CollectionSetWithAgent or an empty value if nothing should be persisted

Throws:

Exception - if an error occured while generating the collection set

handleMessageLog

public void handleMessageLog(TelemetryMessageLogDTO messageLog)

Description copied from interface: Adapter

Handle the messages. IMPORTANT: Implementations of this method MUST be thread-safe.

Specified by:

handleMessageLog in interface Adapter

Parameters:

messageLog - group of messages to be handled

setProtocol

public void setProtocol(Protocol protocol)

Description copied from interface: Adapter

A single instance of an adapter will only be responsible for one protocol. The protocol will be set using this method before any calls to Adapter.handleMessageLog(org.opennms.netmgt.telemetry.ipc.TelemetryMessageLogDTO) are made.

Specified by:

setProtocol in interface Adapter

Parameters:

protocol - the protocol in which the adapter is defined