org.apache.pulsar.client.impl

Class TopicMessageImpl<T>

java.lang.Object

org.apache.pulsar.client.impl.TopicMessageImpl<T>

All Implemented Interfaces:

Message<T>

public class TopicMessageImpl<T>
extends Object
implements Message<T>

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Get the content of the message
Optional<EncryptionContext>	getEncryptionCtx() EncryptionContext contains encryption and compression information in it using which application can decrypt consumed message with encrypted-payload.
long	getEventTime() Get the event time associated with this message.
MessageId	getInnerMessageId()
String	getKey() Get the key of the message
byte[]	getKeyBytes() Get bytes in key.
Message<T>	getMessage()
MessageId	getMessageId() Get the unique message ID associated with this message.
String	getProducerName() Get the producer name who produced this message.
Map<String,String>	getProperties() Return the properties attached to the message.
String	getProperty(String name) Get the value of a specific property
long	getPublishTime() Get the publish time of this message.
long	getSequenceId() Get the sequence id associated with this message.
String	getTopicName() Get the topic name without partition part of this message.
String	getTopicPartitionName() Get the topic name which contains partition part for this message.
T	getValue()
boolean	hasBase64EncodedKey() Check whether the key has been base64 encoded.
boolean	hasKey() Check whether the message has a key
boolean	hasProperty(String name) Check whether the message has a specific property attached.

Methods inherited from class java.lang.Object

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

Method Detail

getTopicName

public String getTopicName()

Get the topic name without partition part of this message.

Specified by:

getTopicName in interface Message<T>

Returns:

the name of the topic on which this message was published

getTopicPartitionName

public String getTopicPartitionName()

Get the topic name which contains partition part for this message.

Returns:

the topic name which contains Partition part

getMessageId

public MessageId getMessageId()

Description copied from interface: Message

Get the unique message ID associated with this message. The message id can be used to univocally refer to a message without having the keep the entire payload in memory. Only messages received from the consumer will have a message id assigned.

Specified by:

getMessageId in interface Message<T>

Returns:

the message id null if this message was not received by this client instance

getInnerMessageId

public MessageId getInnerMessageId()

getProperties

public Map<String,String> getProperties()

Description copied from interface: Message

Return the properties attached to the message. Properties are application defined key/value pairs that will be attached to the message

Specified by:

getProperties in interface Message<T>

Returns:

an unmodifiable view of the properties map

hasProperty

public boolean hasProperty(String name)

Description copied from interface: Message

Check whether the message has a specific property attached.

Specified by:

hasProperty in interface Message<T>

Parameters:

name - the name of the property to check

Returns:

true if the message has the specified property

getProperty

public String getProperty(String name)

Description copied from interface: Message

Get the value of a specific property

Specified by:

getProperty in interface Message<T>

Parameters:

name - the name of the property

Returns:

the value of the property or null if the property was not defined

getData

public byte[] getData()

Description copied from interface: Message

Get the content of the message

Specified by:

getData in interface Message<T>

Returns:

the byte array with the message payload

getPublishTime

public long getPublishTime()

Description copied from interface: Message

Get the publish time of this message. The publish time is the timestamp that a client publish the message.

Specified by:

getPublishTime in interface Message<T>

Returns:

publish time of this message.

See Also:

Message.getEventTime()

getEventTime

public long getEventTime()

Description copied from interface: Message

Get the event time associated with this message. It is typically set by the applications via MessageBuilder.setEventTime(long).

If there isn't any event time associated with this event, it will return 0.

Specified by:

getEventTime in interface Message<T>

See Also:

MessageBuilder.setEventTime(long)

getSequenceId

public long getSequenceId()

Description copied from interface: Message

Get the sequence id associated with this message. It is typically set by the applications via MessageBuilder.setSequenceId(long).

Specified by:

getSequenceId in interface Message<T>

Returns:

sequence id associated with this message.

See Also:

MessageBuilder.setEventTime(long)

getProducerName

public String getProducerName()

Description copied from interface: Message

Get the producer name who produced this message.

Specified by:

getProducerName in interface Message<T>

Returns:

producer name who produced this message, null if producer name is not set.

hasKey

public boolean hasKey()

Description copied from interface: Message

Check whether the message has a key

Specified by:

hasKey in interface Message<T>

Returns:

true if the key was set while creating the message

getKey

public String getKey()

Description copied from interface: Message

Get the key of the message

Specified by:

getKey in interface Message<T>

Returns:

the key of the message

hasBase64EncodedKey

public boolean hasBase64EncodedKey()

Description copied from interface: Message

Check whether the key has been base64 encoded.

Specified by:

hasBase64EncodedKey in interface Message<T>

Returns:

true if the key is base64 encoded, false otherwise

getKeyBytes

public byte[] getKeyBytes()

Description copied from interface: Message

Get bytes in key. If the key has been base64 encoded, it is decoded before being returned. Otherwise, if the key is a plain string, this method returns the UTF_8 encoded bytes of the string.

Specified by:

getKeyBytes in interface Message<T>

Returns:

the key in byte[] form

getValue

public T getValue()

Specified by:

getValue in interface Message<T>

getEncryptionCtx

public Optional<EncryptionContext> getEncryptionCtx()

Description copied from interface: Message

EncryptionContext contains encryption and compression information in it using which application can decrypt consumed message with encrypted-payload.

Specified by:

getEncryptionCtx in interface Message<T>

Returns:

getMessage

public Message<T> getMessage()