co.cask.cdap.messaging.store

Interface MessageTable

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractMessageTable

public interface MessageTable
extends Closeable

An interface defining the Message Table operations.

See Also:

Design documentation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageTable.Entry Represents an entry (row) in the message table.

Method Summary

Modifier and Type	Method and Description
co.cask.cdap.api.dataset.lib.CloseableIterator<MessageTable.Entry>	fetch(TopicMetadata metadata, long startTime, int limit, org.apache.tephra.Transaction transaction) Fetches message table entries in the given topic that were publish on or after the given start time.
co.cask.cdap.api.dataset.lib.CloseableIterator<MessageTable.Entry>	fetch(TopicMetadata metadata, MessageId messageId, boolean inclusive, int limit, org.apache.tephra.Transaction transaction) Fetches message table entries in the given topic, starting from the given MessageId.
void	rollback(TopicMetadata metadata, RollbackDetail rollbackDetail) Rollback entries stored earlier, as deleted, under the given topic based on the given information.
void	store(Iterator<? extends MessageTable.Entry> entries) Stores a list of entries to the message table under the given topic.

Methods inherited from interface java.io.Closeable

close

Method Detail

fetch

co.cask.cdap.api.dataset.lib.CloseableIterator<MessageTable.Entry> fetch(TopicMetadata metadata,
                                                                         long startTime,
                                                                         int limit,
                                                                         @Nullable
                                                                         org.apache.tephra.Transaction transaction)
                                                                  throws IOException

Fetches message table entries in the given topic that were publish on or after the given start time.

Parameters:

metadata - metadata of the topic to fetch from

startTime - the publish time to start from

limit - maximum number of messages to fetch

transaction - an optional Transaction to use for fetching

Returns:

a CloseableIterator of MessageTable.Entry.

Throws:

IOException

fetch

co.cask.cdap.api.dataset.lib.CloseableIterator<MessageTable.Entry> fetch(TopicMetadata metadata,
                                                                         MessageId messageId,
                                                                         boolean inclusive,
                                                                         int limit,
                                                                         @Nullable
                                                                         org.apache.tephra.Transaction transaction)
                                                                  throws IOException

Fetches message table entries in the given topic, starting from the given MessageId.

Parameters:

metadata - TopicMetadata of the the topic to fetch from

messageId - the message id to start fetching from

inclusive - indicate whether to include the given MessageId as the first message (if still available) or not.

limit - maximum number of messages to fetch

transaction - an optional Transaction to use for fetching

Returns:

a CloseableIterator of MessageTable.Entry.

Throws:

IOException

store

void store(Iterator<? extends MessageTable.Entry> entries)
    throws IOException

Stores a list of entries to the message table under the given topic.

Parameters:

entries - a list of entries to store. This method guarantees each MessageTable.Entry will be consumed right away, hence it is safe for the Iterator to reuse the same MessageTable.Entry instance.

Throws:

IOException

rollback

void rollback(TopicMetadata metadata,
              RollbackDetail rollbackDetail)
       throws IOException

Rollback entries stored earlier, as deleted, under the given topic based on the given information.

Parameters:

metadata - TopicMetadata of the topic to rollback from

rollbackDetail - RollbackDetail information required to rollback entries

Throws:

IOException