co.cask.cdap.messaging.store

Class ImmutableMessageTableEntry

java.lang.Object

co.cask.cdap.messaging.store.ImmutableMessageTableEntry

All Implemented Interfaces:

MessageTable.Entry

public final class ImmutableMessageTableEntry
extends Object
implements MessageTable.Entry

An immutable implementation of MessageTable.Entry.

Constructor Summary

Constructors

Constructor and Description
ImmutableMessageTableEntry(byte[] row, byte[] payload, byte[] txPtr)

Method Summary

Modifier and Type	Method and Description
int	getGeneration() Returns the generation id of the topic.
byte[]	getPayload() Returns the message payload if MessageTable.Entry.isPayloadReference() return false; otherwise null will be returned.
long	getPublishTimestamp() Returns the timestamp in milliseconds when this entry was written to the message table.
short	getSequenceId() Returns the sequence id generated when this entry was written to the message table.
co.cask.cdap.proto.id.TopicId	getTopicId() Returns the topic id that the entry belongs to.
long	getTransactionWritePointer() Returns the transaction write pointer stored in this entry.
boolean	isPayloadReference() Returns true if the entry is a reference to messages stored in payload table.
boolean	isTransactional() Returns true if the message is a transactional message

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableMessageTableEntry

public ImmutableMessageTableEntry(byte[] row,
                                  @Nullable
                                  byte[] payload,
                                  @Nullable
                                  byte[] txPtr)

Method Detail

getTopicId

public co.cask.cdap.proto.id.TopicId getTopicId()

Description copied from interface: MessageTable.Entry

Returns the topic id that the entry belongs to.

Specified by:

getTopicId in interface MessageTable.Entry

getGeneration

public int getGeneration()

Description copied from interface: MessageTable.Entry

Returns the generation id of the topic.

Specified by:

getGeneration in interface MessageTable.Entry

isPayloadReference

public boolean isPayloadReference()

Description copied from interface: MessageTable.Entry

Returns true if the entry is a reference to messages stored in payload table.

Specified by:

isPayloadReference in interface MessageTable.Entry

isTransactional

public boolean isTransactional()

Description copied from interface: MessageTable.Entry

Returns true if the message is a transactional message

Specified by:

isTransactional in interface MessageTable.Entry

getTransactionWritePointer

public long getTransactionWritePointer()

Description copied from interface: MessageTable.Entry

Returns the transaction write pointer stored in this entry. The value returned will be valid if and only if MessageTable.Entry.isTransactional() returns true.

Specified by:

getTransactionWritePointer in interface MessageTable.Entry

getPayload

@Nullable
public byte[] getPayload()

Description copied from interface: MessageTable.Entry

Returns the message payload if MessageTable.Entry.isPayloadReference() return false; otherwise null will be returned.

Specified by:

getPayload in interface MessageTable.Entry

getPublishTimestamp

public long getPublishTimestamp()

Description copied from interface: MessageTable.Entry

Returns the timestamp in milliseconds when this entry was written to the message table.

Specified by:

getPublishTimestamp in interface MessageTable.Entry

getSequenceId

public short getSequenceId()

Description copied from interface: MessageTable.Entry

Returns the sequence id generated when this entry was written to the message table.

Specified by:

getSequenceId in interface MessageTable.Entry