com.github.ddth.queue.impl

Class BaseUniversalQueueMessage

java.lang.Object

com.github.ddth.dao.BaseBo

com.github.ddth.queue.impl.BaseUniversalQueueMessage

All Implemented Interfaces:

IQueueMessage, Cloneable

Direct Known Subclasses:

UniversalQueueMessage, UniversalQueueMessage

public abstract class BaseUniversalQueueMessage
extends com.github.ddth.dao.BaseBo
implements IQueueMessage

Base class for universal queue messages.

Fields:

• queue_id: see IQueueMessage.qId()
• org_timestamp (type: java.util.Date): see IQueueMessage.qOriginalTimestamp()
• timestamp (type: java.util.Date): see IQueueMessage.qTimestamp()
• num_requeues (type: int): see IQueueMessage.qNumRequeues()
• content (type: byte[]): message's content
• partitionKey (type: string): key for partitioning messages, see partitionKey()

Since:

0.3.3

Author:

Thanh Ba Nguyen

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.ddth.queue.IQueueMessage

IQueueMessage.EmptyQueueMessage

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_CONTENT
static String	FIELD_NUM_REQUEUES
static String	FIELD_ORG_TIMESTAMP
static String	FIELD_PARTITION_KEY Key used for partitioning messages.
static String	FIELD_QUEUE_ID
static String	FIELD_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
BaseUniversalQueueMessage()

Method Summary

Modifier and Type	Method and Description
BaseUniversalQueueMessage	clone() Clones this message.
byte[]	content() Gets message's content.
BaseUniversalQueueMessage	content(byte[] content) Sets message's content.
BaseUniversalQueueMessage	content(String content) Sets message's content.
String	contentAsString() Gets message's content as a String.
static <T extends BaseUniversalQueueMessage> T	fromBytes(byte[] msgData, Class<T> clazz) Deserializes from a byte[] - which has been serialized by toBytes().
BaseUniversalQueueMessage	fromJson(String jsonString)
String	partitionKey() Key used for partitioning messages (some queue implementations, such as Kafka queue, use this).
BaseUniversalQueueMessage	partitionKey(String key) Key used for partitioning messages (some queue implementations, such as Kafka queue, use this).
byte[]	qData() Data/content attached to the queue message.
BaseUniversalQueueMessage	qData(Object data) Attaches data/content to the queue message.
BaseUniversalQueueMessage	qIncNumRequeues() Increases message's number of re-queue times by 1.
int	qNumRequeues() How many times message has been re-queued?
BaseUniversalQueueMessage	qNumRequeues(int numRequeues) Sets message's number of re-queue times.
Date	qOriginalTimestamp() Message's first-queued timestamp.
BaseUniversalQueueMessage	qOriginalTimestamp(Date timestamp) Sets message's first-queued timestamp.
Date	qTimestamp() Message's last-queued timestamp.
BaseUniversalQueueMessage	qTimestamp(Date timestamp) Sets message's last-queued timestamp.
byte[]	toBytes() Serializes to byte[].

Methods inherited from class com.github.ddth.dao.BaseBo

equals, fromByteArray, fromMap, getAttribute, getAttribute, hashCode, isDirty, markClean, markDirty, setAttribute, toByteArray, toJson, toMap, toString, triggerPopulate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.ddth.queue.IQueueMessage

qId, qId

Field Detail

FIELD_QUEUE_ID

public static final String FIELD_QUEUE_ID

See Also:

Constant Field Values

FIELD_ORG_TIMESTAMP

public static final String FIELD_ORG_TIMESTAMP

See Also:

Constant Field Values

FIELD_TIMESTAMP

public static final String FIELD_TIMESTAMP

See Also:

Constant Field Values

FIELD_NUM_REQUEUES

public static final String FIELD_NUM_REQUEUES

See Also:

Constant Field Values

FIELD_CONTENT

public static final String FIELD_CONTENT

See Also:

Constant Field Values

FIELD_PARTITION_KEY

public static final String FIELD_PARTITION_KEY

Key used for partitioning messages.

Since:

0.3.3.2

See Also:

Constant Field Values

Constructor Detail

BaseUniversalQueueMessage

public BaseUniversalQueueMessage()

Method Detail

clone

public BaseUniversalQueueMessage clone()

Clones this message.

Specified by:

clone in interface IQueueMessage

Overrides:

clone in class Object

Returns:

partitionKey

public String partitionKey()

Key used for partitioning messages (some queue implementations, such as Kafka queue, use this).

Returns:

Since:

0.3.3.2

partitionKey

public BaseUniversalQueueMessage partitionKey(String key)

Key used for partitioning messages (some queue implementations, such as Kafka queue, use this).

Parameters:

key -

Returns:

Since:

0.3.3.2

qOriginalTimestamp

public Date qOriginalTimestamp()

Message's first-queued timestamp.

Specified by:

qOriginalTimestamp in interface IQueueMessage

Returns:

qOriginalTimestamp

public BaseUniversalQueueMessage qOriginalTimestamp(Date timestamp)

Sets message's first-queued timestamp.

Specified by:

qOriginalTimestamp in interface IQueueMessage

Returns:

qTimestamp

public Date qTimestamp()

Message's last-queued timestamp.

Specified by:

qTimestamp in interface IQueueMessage

Returns:

qTimestamp

public BaseUniversalQueueMessage qTimestamp(Date timestamp)

Sets message's last-queued timestamp.

Specified by:

qTimestamp in interface IQueueMessage

Returns:

qNumRequeues

public int qNumRequeues()

How many times message has been re-queued?

Specified by:

qNumRequeues in interface IQueueMessage

Returns:

qNumRequeues

public BaseUniversalQueueMessage qNumRequeues(int numRequeues)

Sets message's number of re-queue times.

Specified by:

qNumRequeues in interface IQueueMessage

Returns:

qIncNumRequeues

public BaseUniversalQueueMessage qIncNumRequeues()

Increases message's number of re-queue times by 1.

Specified by:

qIncNumRequeues in interface IQueueMessage

Returns:

qData

public byte[] qData()

Data/content attached to the queue message.

Specified by:

qData in interface IQueueMessage

Returns:

Since:

0.4.2

qData

public BaseUniversalQueueMessage qData(Object data)

Attaches data/content to the queue message.

Specified by:

qData in interface IQueueMessage

Returns:

Since:

0.4.2

content

public byte[] content()

Gets message's content.

Returns:

contentAsString

public String contentAsString()

Gets message's content as a String.

Returns:

content

public BaseUniversalQueueMessage content(byte[] content)

Sets message's content.

Parameters:

content -

Returns:

content

public BaseUniversalQueueMessage content(String content)

Sets message's content.

Parameters:

content -

Returns:

toBytes

public byte[] toBytes()

Serializes to byte[].

Returns:

fromJson

public BaseUniversalQueueMessage fromJson(String jsonString)

Overrides:

fromJson in class com.github.ddth.dao.BaseBo

fromBytes

public static <T extends BaseUniversalQueueMessage> T fromBytes(byte[] msgData,
                                                                Class<T> clazz)
                                                         throws InstantiationException,
                                                                IllegalAccessException

Deserializes from a byte[] - which has been serialized by toBytes().

Parameters:

msgData -

Returns:

Throws:

IllegalAccessException

InstantiationException