org.opennms.core.ipc.sink.api

Interface SinkModule<S extends Message,T extends Message>

Type Parameters:

S - type of message that will be sent by the producers

T - type of message that will be received by the consumers

All Known Implementing Classes:

AbstractXmlSinkModule, HeartbeatModule, MockSinkModule, SyslogSinkModule, TelemetrySinkModule, TrapSinkModule

public interface SinkModule<S extends Message,T extends Message>

Defines how the messages will be routed and marshaled/unmarshaled over the wire. Messages can be aggregated by an optional AggregationPolicy. If aggregation is not used, the message type sent by the producers must match the message type received by the consumers.

Author:

jwhite

Method Summary

Modifier and Type	Method and Description
AggregationPolicy<S,T>	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.
String	marshal(T message) Marshals the message to a string.
T	unmarshal(String message) Unmarshals the message from a string.

Method Detail

getId

String getId()

Globally unique identifier. Used in the JMS queue name in the Camel implementation.

getNumConsumerThreads

int getNumConsumerThreads()

The number of threads used to consume from the broker.

marshal

String marshal(T message)

Marshals the message to a string.

unmarshal

T unmarshal(String message)

Unmarshals the message from a string.

getAggregationPolicy

AggregationPolicy<S,T> getAggregationPolicy()

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

AsyncPolicy getAsyncPolicy()

Defines how messages should be asynchronously dispatched.

Returns:

the AsyncPolicy used when asynchronously dispatching messages for this module.