com.github.ddth.queue

Class UniversalQueueMessage

java.lang.Object

com.github.ddth.dao.BaseBo

com.github.ddth.queue.UniversalQueueMessage

All Implemented Interfaces:

IQueueMessage

public class UniversalQueueMessage
extends com.github.ddth.dao.BaseBo
implements IQueueMessage

Universal queue message.

Fields:

• queue_id (long): see IQueueMessage.qId()
• org_timestamp: see IQueueMessage.qOriginalTimestamp()
• timestamp: see IQueueMessage.qTimestamp()
• num_requeues: see IQueueMessage.qNumRequeues()
• content (byte[]): message's content

Since:

0.2.2

Author:

Thanh Ba Nguyen

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_QUEUE_ID
static String	FIELD_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
UniversalQueueMessage()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	content() Gets message's content.
UniversalQueueMessage	content(byte[] content) Sets message's content.
static UniversalQueueMessage	fromBytes(byte[] msgData) Deserializes from a byte[].
static UniversalQueueMessage	newInstance() Creates a new UniversalQueueMessage object.
Long	qId() Message's unique id in queue.
UniversalQueueMessage	qId(Object queueId) Sets message's unique queue id.
UniversalQueueMessage	qIncNumRequeues() Increases message's number of re-queue times by 1.
int	qNumRequeues() How many times message has been re-queued?
UniversalQueueMessage	qNumRequeues(int numRequeues) Sets message's number of re-queue times.
Date	qOriginalTimestamp() Message's first-queued timestamp.
UniversalQueueMessage	qOriginalTimestamp(Date timestamp) Sets message's first-queued timestamp.
Date	qTimestamp() Message's last-queued timestamp.
UniversalQueueMessage	qTimestamp(Date timestamp) Sets message's last-queued timestamp.
byte[]	toBytes() Serializes to byte[].

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

equals, fromJson, fromMap, getAttribute, getAttribute, hashCode, isDirty, markClean, markDirty, newObjectFromJson, setAttribute, toJson, toMap, toString

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_QUEUE_ID

public static final String FIELD_QUEUE_ID

Since:

v0.2.2.2

See Also:

Constant Field Values

FIELD_ORG_TIMESTAMP

public static final String FIELD_ORG_TIMESTAMP

Since:

v0.2.2.2

See Also:

Constant Field Values

FIELD_TIMESTAMP

public static final String FIELD_TIMESTAMP

Since:

v0.2.2.2

See Also:

Constant Field Values

FIELD_NUM_REQUEUES

public static final String FIELD_NUM_REQUEUES

Since:

v0.2.2.2

See Also:

Constant Field Values

FIELD_CONTENT

public static final String FIELD_CONTENT

Since:

v0.2.2.2

See Also:

Constant Field Values

Constructor Detail

UniversalQueueMessage

public UniversalQueueMessage()

Method Detail

newInstance

public static UniversalQueueMessage newInstance()

Creates a new UniversalQueueMessage object.

Returns:

qId

public Long qId()

Message's unique id in queue.

Specified by:

qId in interface IQueueMessage

Returns:

qId

public UniversalQueueMessage qId(Object queueId)

Sets message's unique queue id.

Specified by:

qId in interface IQueueMessage

Returns:

qOriginalTimestamp

public Date qOriginalTimestamp()

Message's first-queued timestamp.

Specified by:

qOriginalTimestamp in interface IQueueMessage

Returns:

qOriginalTimestamp

public UniversalQueueMessage 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 UniversalQueueMessage qTimestamp(Date timestamp)

Sets message's last-queued timestamp.

Specified by:

qTimestamp in interface IQueueMessage

Returns:

qNumRequeues

public int qNumRequeues()

Description copied from interface: IQueueMessage

How many times message has been re-queued?

Specified by:

qNumRequeues in interface IQueueMessage

Returns:

qNumRequeues

public UniversalQueueMessage qNumRequeues(int numRequeues)

Sets message's number of re-queue times.

Specified by:

qNumRequeues in interface IQueueMessage

Returns:

qIncNumRequeues

public UniversalQueueMessage qIncNumRequeues()

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

Specified by:

qIncNumRequeues in interface IQueueMessage

Returns:

content

public byte[] content()

Gets message's content.

Returns:

content

public UniversalQueueMessage content(byte[] content)

Sets message's content.

Parameters:

content -

Returns:

toBytes

public byte[] toBytes()

Serializes to byte[].

Returns:

Since:

0.3.2

fromBytes

public static UniversalQueueMessage fromBytes(byte[] msgData)

Deserializes from a byte[].

Parameters:

msgData -

Returns:

Since:

0.3.2