org.eclipse.kura.message.store

Class StoredMessage

java.lang.Object

org.eclipse.kura.message.store.StoredMessage

@ProviderType
public class StoredMessage
extends java.lang.Object

Represents a message stored by a MessageStore implementation.

Since:

2.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StoredMessage.Builder A builder that can be used to create StoredMessage instances.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Optional<java.util.Date>	getConfirmedOn() For messages with QoS greater or equal than one, this field reports the timestamp of the instant when the confirmation has been received from the recipient.
java.util.Optional<java.util.Date>	getCreatedOn() Returns the timestamp of the instant when this message has been added to a store.
java.util.Optional<DataTransportToken>	getDataTransportToken() Returns the DataTransportToken associated with this message, if any.
java.util.Optional<java.util.Date>	getDroppedOn() Returns the timestamp of the instant when this messages has been discarded.
int	getId() Returns the unique identifier of this message.
byte[]	getPayload() Returns the message payload.
int	getPriority() Defines a message priority.
java.util.Optional<java.util.Date>	getPublishedOn() Returns the timestamp of the instant when this message has been sent to the recipient.
int	getQos() Returns the QoS of this message.
java.lang.String	getTopic() Returns the topic of this message.
int	hashCode()
boolean	isRetain() Returns the value of the MQTT retain field.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getId

public int getId()

Returns the unique identifier of this message.

Returns:

the unique identifier of this message.

getTopic

public java.lang.String getTopic()

Returns the topic of this message.

Returns:

the topic.

getQos

public int getQos()

Returns the QoS of this message. A QoS value of zero indicates that the message reception does not need to be acknowledged by the recipient. A QoS value greater or equal than one indicates that the acknowledgement is required.

Returns:

the QoS value

See Also:

getConfirmedOn()

isRetain

public boolean isRetain()

Returns the value of the MQTT retain field.

Returns:

the value of the MQTT retain.

getPriority

public int getPriority()

Defines a message priority. The lower the value of this field, the higher the priority.
Messages with higher priority (lower value of this field) will be published first.

Returns:

the priority value

getPayload

public byte[] getPayload()

Returns the message payload.

Returns:

the message payload.

getCreatedOn

public java.util.Optional<java.util.Date> getCreatedOn()

Returns the timestamp of the instant when this message has been added to a store.

Returns:

the timestamp of creation instant

getPublishedOn

public java.util.Optional<java.util.Date> getPublishedOn()

Returns the timestamp of the instant when this message has been sent to the recipient. An empty value means that the message has not been sent yet.

Returns:

the publish timestamp, if any.

getConfirmedOn

public java.util.Optional<java.util.Date> getConfirmedOn()

For messages with QoS greater or equal than one, this field reports the timestamp of the instant when the confirmation has been received from the recipient.
The returned value will be emtpy for messages with QoS zero, or for messages with QoS greater or equal than one that have not been confirmed yet.

Returns:

the timestamp of the confirmation, if any

See Also:

getQos()

getDroppedOn

public java.util.Optional<java.util.Date> getDroppedOn()

Returns the timestamp of the instant when this messages has been discarded. If returned value is empty, this message has not been dropped.

Returns:

the discard timestamp, if any

getDataTransportToken

public java.util.Optional<DataTransportToken> getDataTransportToken()

Returns the DataTransportToken associated with this message, if any. A DataTransportToken is an identifier of this message generated by the DataTransportService instance that published it.

Returns:

the DataTransportToken.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object