org.nuxeo.ecm.platform.importer.mqueues.mqueues

Interface MQAppender<M extends Externalizable>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ChronicleMQAppender, KafkaMQAppender

public interface MQAppender<M extends Externalizable>
extends AutoCloseable

An appender is used to append message into a MQueue. Implementations must be thread safe.

Since:

9.2

Method Summary

Modifier and Type	Method and Description
MQOffset	append(int partition, M message) Append a message into a partition, returns MQOffset position of the message.
default MQOffset	append(String key, M message) Same as append(int, Externalizable), the queue is chosen using a hash of .
boolean	closed() Returns true if the close has been closed.
String	name() Returns the MQueue's name.
int	size() Returns the number of partitions.
boolean	waitFor(MQOffset offset, String group, Duration timeout) Wait for consumer to process a message up to the offset.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

name

String name()

Returns the MQueue's name.

size

int size()

Returns the number of partitions.

append

MQOffset append(int partition,
                M message)

Append a message into a partition, returns MQOffset position of the message. This method is thread safe, a queue can be shared by multiple producers.

Parameters:

partition - index lower than size()

append

default MQOffset append(String key,
                        M message)

Same as append(int, Externalizable), the queue is chosen using a hash of .

waitFor

boolean waitFor(MQOffset offset,
                String group,
                Duration timeout)
         throws InterruptedException

Wait for consumer to process a message up to the offset. The message is processed if a consumer commit its offset (or a bigger one) in the group name space. Return true if the message has been consumed, false in case of timeout.

Throws:

InterruptedException

closed

boolean closed()

Returns true if the close has been closed.