co.cask.cdap.messaging.store

Class AbstractMessageTable

java.lang.Object

co.cask.cdap.messaging.store.AbstractMessageTable

All Implemented Interfaces:

MessageTable, Closeable, AutoCloseable

public abstract class AbstractMessageTable
extends Object
implements MessageTable

Contains common logic for implementation of MessageTable.

Nested Class Summary

Nested classes/interfaces inherited from interface co.cask.cdap.messaging.store.MessageTable

MessageTable.Entry

Constructor Summary

Constructors

Constructor and Description
AbstractMessageTable()

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.
protected abstract void	persist(Iterator<RawMessageTableEntry> entries) Store the RawMessageTableEntrys persistently.
protected abstract co.cask.cdap.api.dataset.lib.CloseableIterator<RawMessageTableEntry>	read(byte[] startRow, byte[] stopRow) Read the RawMessageTableEntrys given a key range.
protected abstract void	rollback(byte[] startKey, byte[] stopKey, byte[] txWritePointer) Rollback the transactionally published messages in the Table in the given key range.
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 class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

AbstractMessageTable

public AbstractMessageTable()

Method Detail

persist

protected abstract void persist(Iterator<RawMessageTableEntry> entries)
                         throws IOException

Store the RawMessageTableEntrys persistently.

Parameters:

entries - Iterator of RawMessageTableEntrys

Throws:

IOException - thrown if there was an error while storing the entries

rollback

protected abstract void rollback(byte[] startKey,
                                 byte[] stopKey,
                                 byte[] txWritePointer)
                          throws IOException

Rollback the transactionally published messages in the Table in the given key range.

Parameters:

startKey - start row to delete (inclusive)

stopKey - stop row to delete (exclusive)

txWritePointer - transaction write pointer for messages that are being roll backed

Throws:

IOException - thrown if there was an error while trying to delete the entries

read

protected abstract co.cask.cdap.api.dataset.lib.CloseableIterator<RawMessageTableEntry> read(byte[] startRow,
                                                                                             byte[] stopRow)
                                                                                      throws IOException

Read the RawMessageTableEntrys given a key range.

Parameters:

startRow - start row prefix

stopRow - stop row prefix

Returns:

CloseableIterator of RawMessageTableEntrys

Throws:

IOException - throw if there was an error while trying to read the entries from the table

fetch

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

Description copied from interface: MessageTable

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

Specified by:

fetch in interface MessageTable

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

public 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

Description copied from interface: MessageTable

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

Specified by:

fetch in interface MessageTable

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

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

Description copied from interface: MessageTable

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

Specified by:

store in interface MessageTable

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

public void rollback(TopicMetadata metadata,
                     RollbackDetail rollbackDetail)
              throws IOException

Description copied from interface: MessageTable

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

Specified by:

rollback in interface MessageTable

Parameters:

metadata - TopicMetadata of the topic to rollback from

rollbackDetail - RollbackDetail information required to rollback entries

Throws:

IOException