MessageImpl (Pulsar Client Java 2.10.0 API)

java.lang.Object
- org.apache.pulsar.client.impl.MessageImpl<T>

All Implemented Interfaces:: Message<T>

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

Field Summary

Fields
Modifier and Type Field and Description

protected MessageId messageId

Fields
Modifier and Type	Field and Description
`protected MessageId`	`messageId`

Constructor Summary

Constructors
Constructor and Description
`MessageImpl(String topic, String msgId, Map<String,String> properties, byte[] payload, Schema<T> schema, MessageMetadata msgMetadata)`
`MessageImpl(String topic, String msgId, Map<String,String> properties, io.netty.buffer.ByteBuf payload, Schema<T> schema, MessageMetadata msgMetadata)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> MessageImpl<T>`	`create(MessageMetadata msgMetadata, ByteBuffer payload, Schema<T> schema, String topic)`
`static <T> MessageImpl<T>`	`create(String topic, BatchMessageIdImpl batchMessageIdImpl, MessageMetadata batchMetadata, SingleMessageMetadata singleMessageMetadata, io.netty.buffer.ByteBuf payload, Optional<EncryptionContext> encryptionCtx, ClientCnx cnx, Schema<T> schema, int redeliveryCount, boolean pooledMessage, long consumerEpoch)`
`static <T> MessageImpl<T>`	`create(String topic, MessageIdImpl messageId, MessageMetadata msgMetadata, io.netty.buffer.ByteBuf payload, Optional<EncryptionContext> encryptionCtx, ClientCnx cnx, Schema<T> schema, int redeliveryCount, boolean pooledMessage, long consumerEpoch)`
`static MessageImpl<byte[]>`	`deserialize(io.netty.buffer.ByteBuf headersAndPayload)`
`static MessageImpl<byte[]>`	`deserializeSkipBrokerEntryMetaData(io.netty.buffer.ByteBuf headersAndPayloadWithBrokerEntryMetadata)`
`BrokerEntryMetadata`	`getBrokerEntryMetadata()`
`Optional<Long>`	`getBrokerPublishTime()`
`ClientCnx`	`getCnx()`
`byte[]`	`getData()`
`io.netty.buffer.ByteBuf`	`getDataBuffer()`
`long`	`getDeliverAtTime()`
`Optional<EncryptionContext>`	`getEncryptionCtx()`
`long`	`getEventTime()`
`Optional<Long>`	`getIndex()`
`String`	`getKey()`
`byte[]`	`getKeyBytes()`
`MessageMetadata`	`getMessageBuilder()`
`MessageId`	`getMessageId()`
`byte[]`	`getOrderingKey()`
`String`	`getProducerName()`
`Map<String,String>`	`getProperties()`
`String`	`getProperty(String name)`
`long`	`getPublishTime()`
`Optional<Schema<?>>`	`getReaderSchema()`
`int`	`getRedeliveryCount()`
`String`	`getReplicatedFrom()`
`List<String>`	`getReplicateTo()`
`SchemaInfo`	`getSchemaInfo()`
`SchemaInfo`	`getSchemaInfoForReplicator()`
`Schema<T>`	`getSchemaInternal()`
`byte[]`	`getSchemaVersion()`
`long`	`getSequenceId()`
`String`	`getTopicName()`
`T`	`getValue()`
`boolean`	`hasBase64EncodedKey()`
`boolean`	`hasBrokerPublishTime()`
`boolean`	`hasIndex()`
`boolean`	`hasKey()`
`boolean`	`hasOrderingKey()`
`boolean`	`hasProperty(String name)`
`boolean`	`hasReplicateFrom()`
`boolean`	`hasReplicateTo()`
`static boolean`	`isEntryExpired(int messageTTLInSeconds, long entryTimestamp)`
`static boolean`	`isEntryPublishedEarlierThan(long entryTimestamp, long timestamp)`
`boolean`	`isExpired(int messageTTLInSeconds)`
`boolean`	`isReplicated()`
`void`	`recycle()`
`void`	`release()`
`void`	`setBrokerEntryMetadata(BrokerEntryMetadata brokerEntryMetadata)`
`void`	`setReplicatedFrom(String cluster)`
`void`	`setSchemaInfoForReplicator(SchemaInfo schemaInfo)`
`int`	`size()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- messageId
```
protected MessageId messageId
```

Constructor Detail

MessageImpl

public MessageImpl(String topic,
                   String msgId,
                   Map<String,String> properties,
                   byte[] payload,
                   Schema<T> schema,
                   MessageMetadata msgMetadata)

MessageImpl

public MessageImpl(String topic,
                   String msgId,
                   Map<String,String> properties,
                   io.netty.buffer.ByteBuf payload,
                   Schema<T> schema,
                   MessageMetadata msgMetadata)

Method Detail

create

public static <T> MessageImpl<T> create(MessageMetadata msgMetadata,
                                        ByteBuffer payload,
                                        Schema<T> schema,
                                        String topic)

create

public static <T> MessageImpl<T> create(String topic,
                                        MessageIdImpl messageId,
                                        MessageMetadata msgMetadata,
                                        io.netty.buffer.ByteBuf payload,
                                        Optional<EncryptionContext> encryptionCtx,
                                        ClientCnx cnx,
                                        Schema<T> schema,
                                        int redeliveryCount,
                                        boolean pooledMessage,
                                        long consumerEpoch)

create

public static <T> MessageImpl<T> create(String topic,
                                        BatchMessageIdImpl batchMessageIdImpl,
                                        MessageMetadata batchMetadata,
                                        SingleMessageMetadata singleMessageMetadata,
                                        io.netty.buffer.ByteBuf payload,
                                        Optional<EncryptionContext> encryptionCtx,
                                        ClientCnx cnx,
                                        Schema<T> schema,
                                        int redeliveryCount,
                                        boolean pooledMessage,
                                        long consumerEpoch)

deserialize

public static MessageImpl<byte[]> deserialize(io.netty.buffer.ByteBuf headersAndPayload)
                                       throws IOException

Throws:: IOException

isEntryExpired

public static boolean isEntryExpired(int messageTTLInSeconds,
                                     long entryTimestamp)

isEntryPublishedEarlierThan

public static boolean isEntryPublishedEarlierThan(long entryTimestamp,
                                                  long timestamp)

deserializeSkipBrokerEntryMetaData

public static MessageImpl<byte[]> deserializeSkipBrokerEntryMetaData(io.netty.buffer.ByteBuf headersAndPayloadWithBrokerEntryMetadata)
                                                              throws IOException

Throws:: IOException

setReplicatedFrom

public void setReplicatedFrom(String cluster)

isReplicated
```
public boolean isReplicated()
```
Specified by:

isReplicated in interface Message<T>

getReplicatedFrom
```
public String getReplicatedFrom()
```
Specified by:

getReplicatedFrom in interface Message<T>

getPublishTime
```
public long getPublishTime()
```
Specified by:

getPublishTime in interface Message<T>

getEventTime
```
public long getEventTime()
```
Specified by:

getEventTime in interface Message<T>

getDeliverAtTime
```
public long getDeliverAtTime()
```

isExpired

public boolean isExpired(int messageTTLInSeconds)

getData
```
public byte[] getData()
```
Specified by:

getData in interface Message<T>

size
```
public int size()
```
Specified by:

size in interface Message<T>

getSchemaInternal
```
public Schema<T> getSchemaInternal()
```

getReaderSchema
```
public Optional<Schema<?>> getReaderSchema()
```
Specified by:

getReaderSchema in interface Message<T>

getSchemaVersion
```
public byte[] getSchemaVersion()
```
Specified by:

getSchemaVersion in interface Message<T>

getSchemaInfo
```
public SchemaInfo getSchemaInfo()
```

setSchemaInfoForReplicator

public void setSchemaInfoForReplicator(SchemaInfo schemaInfo)

getSchemaInfoForReplicator

public SchemaInfo getSchemaInfoForReplicator()

getValue
```
public T getValue()
```
Specified by:

getValue in interface Message<T>

getSequenceId
```
public long getSequenceId()
```
Specified by:

getSequenceId in interface Message<T>

getProducerName
```
public String getProducerName()
```
Specified by:

getProducerName in interface Message<T>

getDataBuffer

public io.netty.buffer.ByteBuf getDataBuffer()

getMessageId
```
public MessageId getMessageId()
```
Specified by:

getMessageId in interface Message<T>

getProperties
```
public Map<String,String> getProperties()
```
Specified by:

getProperties in interface Message<T>

hasProperty
```
public boolean hasProperty(String name)
```
Specified by:

hasProperty in interface Message<T>

getProperty
```
public String getProperty(String name)
```
Specified by:

getProperty in interface Message<T>

getMessageBuilder

public MessageMetadata getMessageBuilder()

hasKey
```
public boolean hasKey()
```
Specified by:

hasKey in interface Message<T>

getTopicName
```
public String getTopicName()
```
Specified by:

getTopicName in interface Message<T>

getKey
```
public String getKey()
```
Specified by:

getKey in interface Message<T>

hasBase64EncodedKey
```
public boolean hasBase64EncodedKey()
```
Specified by:

hasBase64EncodedKey in interface Message<T>

getKeyBytes
```
public byte[] getKeyBytes()
```
Specified by:

getKeyBytes in interface Message<T>

hasOrderingKey
```
public boolean hasOrderingKey()
```
Specified by:

hasOrderingKey in interface Message<T>

getOrderingKey
```
public byte[] getOrderingKey()
```
Specified by:

getOrderingKey in interface Message<T>

getBrokerEntryMetadata

public BrokerEntryMetadata getBrokerEntryMetadata()

setBrokerEntryMetadata

public void setBrokerEntryMetadata(BrokerEntryMetadata brokerEntryMetadata)

getCnx
```
public ClientCnx getCnx()
```

recycle
```
public void recycle()
```

release
```
public void release()
```
Specified by:

release in interface Message<T>

hasBrokerPublishTime
```
public boolean hasBrokerPublishTime()
```
Specified by:

hasBrokerPublishTime in interface Message<T>

getBrokerPublishTime
```
public Optional<Long> getBrokerPublishTime()
```
Specified by:

getBrokerPublishTime in interface Message<T>

hasIndex
```
public boolean hasIndex()
```
Specified by:

hasIndex in interface Message<T>

getIndex
```
public Optional<Long> getIndex()
```
Specified by:

getIndex in interface Message<T>

hasReplicateTo
```
public boolean hasReplicateTo()
```

getReplicateTo
```
public List<String> getReplicateTo()
```

hasReplicateFrom
```
public boolean hasReplicateFrom()
```

getEncryptionCtx
```
public Optional<EncryptionContext> getEncryptionCtx()
```
Specified by:

getEncryptionCtx in interface Message<T>

getRedeliveryCount
```
public int getRedeliveryCount()
```
Specified by:

getRedeliveryCount in interface Message<T>

Class MessageImpl<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

messageId

Constructor Detail

MessageImpl

MessageImpl

Method Detail

create

create

create

deserialize

isEntryExpired

isEntryPublishedEarlierThan

deserializeSkipBrokerEntryMetaData

setReplicatedFrom

isReplicated

getReplicatedFrom

getPublishTime

getEventTime

getDeliverAtTime

isExpired

getData

size

getSchemaInternal

getReaderSchema

getSchemaVersion

getSchemaInfo

setSchemaInfoForReplicator

getSchemaInfoForReplicator

getValue

getSequenceId

getProducerName

getDataBuffer

getMessageId

getProperties

hasProperty

getProperty

getMessageBuilder

hasKey

getTopicName

getKey

hasBase64EncodedKey

getKeyBytes

hasOrderingKey

getOrderingKey

getBrokerEntryMetadata

setBrokerEntryMetadata

getCnx

recycle

release

hasBrokerPublishTime

getBrokerPublishTime

hasIndex

getIndex

hasReplicateTo

getReplicateTo

hasReplicateFrom

getEncryptionCtx

getRedeliveryCount