org.apache.pulsar.common.api

Class Commands

java.lang.Object

org.apache.pulsar.common.api.Commands

public class Commands
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Commands.ChecksumType

Field Summary

Fields

Modifier and Type	Field and Description
static short	magicCrc32c

Constructor Summary

Constructors

Constructor and Description
Commands()

Method Summary

Modifier and Type	Method and Description
static io.netty.buffer.ByteBuf	deSerializeSingleMessageInBatch(io.netty.buffer.ByteBuf uncompressedPayload, PulsarApi.SingleMessageMetadata.Builder singleMessageMetadataBuilder, int index, int batchSize)
static int	getCurrentProtocolVersion()
static SchemaType	getSchemaType(PulsarApi.Schema.Type type)
static boolean	hasChecksum(io.netty.buffer.ByteBuf buffer)
static long	initBatchMessageMetadata(PulsarApi.MessageMetadata.Builder messageMetadata, PulsarApi.MessageMetadata.Builder builder)
static io.netty.buffer.ByteBuf	newAck(long consumerId, long ledgerId, long entryId, PulsarApi.CommandAck.AckType ackType, PulsarApi.CommandAck.ValidationError validationError, Map<String,Long> properties)
static io.netty.buffer.ByteBuf	newActiveConsumerChange(long consumerId, boolean isActive)
static io.netty.buffer.ByteBuf	newCloseConsumer(long consumerId, long requestId)
static io.netty.buffer.ByteBuf	newCloseProducer(long producerId, long requestId)
static io.netty.buffer.ByteBuf	newConnect(String authMethodName, String authData, int protocolVersion, String libVersion, String targetBroker, String originalPrincipal, String originalAuthData, String originalAuthMethod)
static io.netty.buffer.ByteBuf	newConnect(String authMethodName, String authData, String libVersion)
static io.netty.buffer.ByteBuf	newConnect(String authMethodName, String authData, String libVersion, String targetBroker)
static io.netty.buffer.ByteBuf	newConnect(String authMethodName, String authData, String libVersion, String targetBroker, String originalPrincipal, String clientAuthData, String clientAuthMethod)
static io.netty.buffer.ByteBuf	newConnected(int clientProtocolVersion)
static io.netty.buffer.ByteBuf	newConsumerStatsResponse(PulsarApi.CommandConsumerStatsResponse.Builder builder)
static io.netty.buffer.ByteBuf	newConsumerStatsResponse(PulsarApi.ServerError serverError, String errMsg, long requestId)
static io.netty.buffer.ByteBuf	newError(long requestId, PulsarApi.ServerError error, String message)
static io.netty.buffer.ByteBuf	newFlow(long consumerId, int messagePermits)
static io.netty.buffer.ByteBuf	newGetLastMessageId(long consumerId, long requestId)
static io.netty.buffer.ByteBuf	newGetLastMessageIdResponse(long requestId, PulsarApi.MessageIdData messageIdData)
static io.netty.buffer.ByteBuf	newGetSchema(long requestId, String topic, Optional<SchemaVersion> version)
static io.netty.buffer.ByteBuf	newGetSchemaResponse(long requestId, SchemaInfo schema, SchemaVersion version)
static io.netty.buffer.ByteBuf	newGetSchemaResponseError(long requestId, PulsarApi.ServerError error, String errorMessage)
static io.netty.buffer.ByteBuf	newGetTopicsOfNamespaceRequest(String namespace, long requestId, PulsarApi.CommandGetTopicsOfNamespace.Mode mode)
static io.netty.buffer.ByteBuf	newGetTopicsOfNamespaceResponse(List<String> topics, long requestId)
static io.netty.buffer.ByteBuf	newLookup(String topic, boolean authoritative, long requestId)
static io.netty.buffer.ByteBuf	newLookupErrorResponse(PulsarApi.ServerError error, String errorMsg, long requestId)
static io.netty.buffer.ByteBuf	newLookupResponse(String brokerServiceUrl, String brokerServiceUrlTls, boolean authoritative, PulsarApi.CommandLookupTopicResponse.LookupType response, long requestId, boolean proxyThroughServiceUrl)
static ByteBufPair	newMessage(long consumerId, PulsarApi.MessageIdData messageId, int redeliveryCount, io.netty.buffer.ByteBuf metadataAndPayload)
static io.netty.buffer.ByteBuf	newMultiMessageAck(long consumerId, List<org.apache.commons.lang3.tuple.Pair<Long,Long>> entries)
static io.netty.buffer.ByteBuf	newPartitionMetadataRequest(String topic, long requestId)
static io.netty.buffer.ByteBuf	newPartitionMetadataResponse(int partitions, long requestId)
static io.netty.buffer.ByteBuf	newPartitionMetadataResponse(PulsarApi.ServerError error, String errorMsg, long requestId)
static io.netty.buffer.ByteBuf	newProducer(String topic, long producerId, long requestId, String producerName, boolean encrypted, Map<String,String> metadata)
static io.netty.buffer.ByteBuf	newProducer(String topic, long producerId, long requestId, String producerName, boolean encrypted, Map<String,String> metadata, SchemaInfo schemaInfo)
static io.netty.buffer.ByteBuf	newProducer(String topic, long producerId, long requestId, String producerName, Map<String,String> metadata)
static io.netty.buffer.ByteBuf	newProducerSuccess(long requestId, String producerName, long lastSequenceId, SchemaVersion schemaVersion)
static io.netty.buffer.ByteBuf	newProducerSuccess(long requestId, String producerName, SchemaVersion schemaVersion)
static io.netty.buffer.ByteBuf	newReachedEndOfTopic(long consumerId)
static io.netty.buffer.ByteBuf	newRedeliverUnacknowledgedMessages(long consumerId)
static io.netty.buffer.ByteBuf	newRedeliverUnacknowledgedMessages(long consumerId, List<PulsarApi.MessageIdData> messageIds)
static io.netty.buffer.ByteBuf	newSeek(long consumerId, long requestId, long ledgerId, long entryId)
static ByteBufPair	newSend(long producerId, long sequenceId, int numMessages, Commands.ChecksumType checksumType, PulsarApi.MessageMetadata messageData, io.netty.buffer.ByteBuf payload)
static io.netty.buffer.ByteBuf	newSendError(long producerId, long sequenceId, PulsarApi.ServerError error, String errorMsg)
static io.netty.buffer.ByteBuf	newSendReceipt(long producerId, long sequenceId, long ledgerId, long entryId)
static io.netty.buffer.ByteBuf	newSubscribe(String topic, String subscription, long consumerId, long requestId, PulsarApi.CommandSubscribe.SubType subType, int priorityLevel, String consumerName)
static io.netty.buffer.ByteBuf	newSubscribe(String topic, String subscription, long consumerId, long requestId, PulsarApi.CommandSubscribe.SubType subType, int priorityLevel, String consumerName, boolean isDurable, PulsarApi.MessageIdData startMessageId, Map<String,String> metadata, boolean readCompacted, PulsarApi.CommandSubscribe.InitialPosition subscriptionInitialPosition, SchemaInfo schemaInfo)
static io.netty.buffer.ByteBuf	newSuccess(long requestId)
static io.netty.buffer.ByteBuf	newUnsubscribe(long consumerId, long requestId)
static PulsarApi.MessageMetadata	parseMessageMetadata(io.netty.buffer.ByteBuf buffer)
static boolean	peerSupportJsonSchemaAvroFormat(int peerVersion)
static boolean	peerSupportsActiveConsumerListener(int peerVersion)
static boolean	peerSupportsGetLastMessageId(int peerVersion)
static boolean	peerSupportsMultiMessageAcknowledgment(int peerVersion)
static int	readChecksum(io.netty.buffer.ByteBuf buffer) Read the checksum and advance the reader index in the buffer.
static io.netty.buffer.ByteBuf	serializeMetadataAndPayload(Commands.ChecksumType checksumType, PulsarApi.MessageMetadata msgMetadata, io.netty.buffer.ByteBuf payload)
static io.netty.buffer.ByteBuf	serializeSingleMessageInBatchWithPayload(PulsarApi.MessageMetadata.Builder msgBuilder, io.netty.buffer.ByteBuf payload, io.netty.buffer.ByteBuf batchBuffer)
static io.netty.buffer.ByteBuf	serializeSingleMessageInBatchWithPayload(PulsarApi.SingleMessageMetadata.Builder singleMessageMetadataBuilder, io.netty.buffer.ByteBuf payload, io.netty.buffer.ByteBuf batchBuffer)
static io.netty.buffer.ByteBuf	serializeWithSize(PulsarApi.BaseCommand.Builder cmdBuilder)
static void	skipChecksumIfPresent(io.netty.buffer.ByteBuf buffer)

Methods inherited from class java.lang.Object

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

Field Detail

magicCrc32c

public static final short magicCrc32c

See Also:

Constant Field Values

Constructor Detail

Commands

public Commands()

Method Detail

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 String authData,
                                                 String libVersion)

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 String authData,
                                                 String libVersion,
                                                 String targetBroker)

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 String authData,
                                                 String libVersion,
                                                 String targetBroker,
                                                 String originalPrincipal,
                                                 String clientAuthData,
                                                 String clientAuthMethod)

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 String authData,
                                                 int protocolVersion,
                                                 String libVersion,
                                                 String targetBroker,
                                                 String originalPrincipal,
                                                 String originalAuthData,
                                                 String originalAuthMethod)

newConnected

public static io.netty.buffer.ByteBuf newConnected(int clientProtocolVersion)

newSuccess

public static io.netty.buffer.ByteBuf newSuccess(long requestId)

newProducerSuccess

public static io.netty.buffer.ByteBuf newProducerSuccess(long requestId,
                                                         String producerName,
                                                         SchemaVersion schemaVersion)

newProducerSuccess

public static io.netty.buffer.ByteBuf newProducerSuccess(long requestId,
                                                         String producerName,
                                                         long lastSequenceId,
                                                         SchemaVersion schemaVersion)

newError

public static io.netty.buffer.ByteBuf newError(long requestId,
                                               PulsarApi.ServerError error,
                                               String message)

newSendReceipt

public static io.netty.buffer.ByteBuf newSendReceipt(long producerId,
                                                     long sequenceId,
                                                     long ledgerId,
                                                     long entryId)

newSendError

public static io.netty.buffer.ByteBuf newSendError(long producerId,
                                                   long sequenceId,
                                                   PulsarApi.ServerError error,
                                                   String errorMsg)

hasChecksum

public static boolean hasChecksum(io.netty.buffer.ByteBuf buffer)

readChecksum

public static int readChecksum(io.netty.buffer.ByteBuf buffer)

Read the checksum and advance the reader index in the buffer. Note: This method assume the checksum presence was already verified before.

skipChecksumIfPresent

public static void skipChecksumIfPresent(io.netty.buffer.ByteBuf buffer)

parseMessageMetadata

public static PulsarApi.MessageMetadata parseMessageMetadata(io.netty.buffer.ByteBuf buffer)

newMessage

public static ByteBufPair newMessage(long consumerId,
                                     PulsarApi.MessageIdData messageId,
                                     int redeliveryCount,
                                     io.netty.buffer.ByteBuf metadataAndPayload)

newSend

public static ByteBufPair newSend(long producerId,
                                  long sequenceId,
                                  int numMessages,
                                  Commands.ChecksumType checksumType,
                                  PulsarApi.MessageMetadata messageData,
                                  io.netty.buffer.ByteBuf payload)

newSubscribe

public static io.netty.buffer.ByteBuf newSubscribe(String topic,
                                                   String subscription,
                                                   long consumerId,
                                                   long requestId,
                                                   PulsarApi.CommandSubscribe.SubType subType,
                                                   int priorityLevel,
                                                   String consumerName)

newSubscribe

public static io.netty.buffer.ByteBuf newSubscribe(String topic,
                                                   String subscription,
                                                   long consumerId,
                                                   long requestId,
                                                   PulsarApi.CommandSubscribe.SubType subType,
                                                   int priorityLevel,
                                                   String consumerName,
                                                   boolean isDurable,
                                                   PulsarApi.MessageIdData startMessageId,
                                                   Map<String,String> metadata,
                                                   boolean readCompacted,
                                                   PulsarApi.CommandSubscribe.InitialPosition subscriptionInitialPosition,
                                                   SchemaInfo schemaInfo)

newUnsubscribe

public static io.netty.buffer.ByteBuf newUnsubscribe(long consumerId,
                                                     long requestId)

newActiveConsumerChange

public static io.netty.buffer.ByteBuf newActiveConsumerChange(long consumerId,
                                                              boolean isActive)

newSeek

public static io.netty.buffer.ByteBuf newSeek(long consumerId,
                                              long requestId,
                                              long ledgerId,
                                              long entryId)

newCloseConsumer

public static io.netty.buffer.ByteBuf newCloseConsumer(long consumerId,
                                                       long requestId)

newReachedEndOfTopic

public static io.netty.buffer.ByteBuf newReachedEndOfTopic(long consumerId)

newCloseProducer

public static io.netty.buffer.ByteBuf newCloseProducer(long producerId,
                                                       long requestId)

newProducer

public static io.netty.buffer.ByteBuf newProducer(String topic,
                                                  long producerId,
                                                  long requestId,
                                                  String producerName,
                                                  Map<String,String> metadata)

newProducer

public static io.netty.buffer.ByteBuf newProducer(String topic,
                                                  long producerId,
                                                  long requestId,
                                                  String producerName,
                                                  boolean encrypted,
                                                  Map<String,String> metadata)

getSchemaType

public static SchemaType getSchemaType(PulsarApi.Schema.Type type)

newProducer

public static io.netty.buffer.ByteBuf newProducer(String topic,
                                                  long producerId,
                                                  long requestId,
                                                  String producerName,
                                                  boolean encrypted,
                                                  Map<String,String> metadata,
                                                  SchemaInfo schemaInfo)

newPartitionMetadataResponse

public static io.netty.buffer.ByteBuf newPartitionMetadataResponse(PulsarApi.ServerError error,
                                                                   String errorMsg,
                                                                   long requestId)

newPartitionMetadataRequest

public static io.netty.buffer.ByteBuf newPartitionMetadataRequest(String topic,
                                                                  long requestId)

newPartitionMetadataResponse

public static io.netty.buffer.ByteBuf newPartitionMetadataResponse(int partitions,
                                                                   long requestId)

newLookup

public static io.netty.buffer.ByteBuf newLookup(String topic,
                                                boolean authoritative,
                                                long requestId)

newLookupResponse

public static io.netty.buffer.ByteBuf newLookupResponse(String brokerServiceUrl,
                                                        String brokerServiceUrlTls,
                                                        boolean authoritative,
                                                        PulsarApi.CommandLookupTopicResponse.LookupType response,
                                                        long requestId,
                                                        boolean proxyThroughServiceUrl)

newLookupErrorResponse

public static io.netty.buffer.ByteBuf newLookupErrorResponse(PulsarApi.ServerError error,
                                                             String errorMsg,
                                                             long requestId)

newMultiMessageAck

public static io.netty.buffer.ByteBuf newMultiMessageAck(long consumerId,
                                                         List<org.apache.commons.lang3.tuple.Pair<Long,Long>> entries)

newAck

public static io.netty.buffer.ByteBuf newAck(long consumerId,
                                             long ledgerId,
                                             long entryId,
                                             PulsarApi.CommandAck.AckType ackType,
                                             PulsarApi.CommandAck.ValidationError validationError,
                                             Map<String,Long> properties)

newFlow

public static io.netty.buffer.ByteBuf newFlow(long consumerId,
                                              int messagePermits)

newRedeliverUnacknowledgedMessages

public static io.netty.buffer.ByteBuf newRedeliverUnacknowledgedMessages(long consumerId)

newRedeliverUnacknowledgedMessages

public static io.netty.buffer.ByteBuf newRedeliverUnacknowledgedMessages(long consumerId,
                                                                         List<PulsarApi.MessageIdData> messageIds)

newConsumerStatsResponse

public static io.netty.buffer.ByteBuf newConsumerStatsResponse(PulsarApi.ServerError serverError,
                                                               String errMsg,
                                                               long requestId)

newConsumerStatsResponse

public static io.netty.buffer.ByteBuf newConsumerStatsResponse(PulsarApi.CommandConsumerStatsResponse.Builder builder)

newGetTopicsOfNamespaceRequest

public static io.netty.buffer.ByteBuf newGetTopicsOfNamespaceRequest(String namespace,
                                                                     long requestId,
                                                                     PulsarApi.CommandGetTopicsOfNamespace.Mode mode)

newGetTopicsOfNamespaceResponse

public static io.netty.buffer.ByteBuf newGetTopicsOfNamespaceResponse(List<String> topics,
                                                                      long requestId)

newGetLastMessageId

public static io.netty.buffer.ByteBuf newGetLastMessageId(long consumerId,
                                                          long requestId)

newGetLastMessageIdResponse

public static io.netty.buffer.ByteBuf newGetLastMessageIdResponse(long requestId,
                                                                  PulsarApi.MessageIdData messageIdData)

newGetSchema

public static io.netty.buffer.ByteBuf newGetSchema(long requestId,
                                                   String topic,
                                                   Optional<SchemaVersion> version)

newGetSchemaResponse

public static io.netty.buffer.ByteBuf newGetSchemaResponse(long requestId,
                                                           SchemaInfo schema,
                                                           SchemaVersion version)

newGetSchemaResponseError

public static io.netty.buffer.ByteBuf newGetSchemaResponseError(long requestId,
                                                                PulsarApi.ServerError error,
                                                                String errorMessage)

serializeWithSize

public static io.netty.buffer.ByteBuf serializeWithSize(PulsarApi.BaseCommand.Builder cmdBuilder)

serializeMetadataAndPayload

public static io.netty.buffer.ByteBuf serializeMetadataAndPayload(Commands.ChecksumType checksumType,
                                                                  PulsarApi.MessageMetadata msgMetadata,
                                                                  io.netty.buffer.ByteBuf payload)

initBatchMessageMetadata

public static long initBatchMessageMetadata(PulsarApi.MessageMetadata.Builder messageMetadata,
                                            PulsarApi.MessageMetadata.Builder builder)

serializeSingleMessageInBatchWithPayload

public static io.netty.buffer.ByteBuf serializeSingleMessageInBatchWithPayload(PulsarApi.SingleMessageMetadata.Builder singleMessageMetadataBuilder,
                                                                               io.netty.buffer.ByteBuf payload,
                                                                               io.netty.buffer.ByteBuf batchBuffer)

serializeSingleMessageInBatchWithPayload

public static io.netty.buffer.ByteBuf serializeSingleMessageInBatchWithPayload(PulsarApi.MessageMetadata.Builder msgBuilder,
                                                                               io.netty.buffer.ByteBuf payload,
                                                                               io.netty.buffer.ByteBuf batchBuffer)

deSerializeSingleMessageInBatch

public static io.netty.buffer.ByteBuf deSerializeSingleMessageInBatch(io.netty.buffer.ByteBuf uncompressedPayload,
                                                                      PulsarApi.SingleMessageMetadata.Builder singleMessageMetadataBuilder,
                                                                      int index,
                                                                      int batchSize)
                                                               throws IOException

Throws:

IOException

getCurrentProtocolVersion

public static int getCurrentProtocolVersion()

peerSupportsGetLastMessageId

public static boolean peerSupportsGetLastMessageId(int peerVersion)

peerSupportsActiveConsumerListener

public static boolean peerSupportsActiveConsumerListener(int peerVersion)

peerSupportsMultiMessageAcknowledgment

public static boolean peerSupportsMultiMessageAcknowledgment(int peerVersion)

peerSupportJsonSchemaAvroFormat

public static boolean peerSupportJsonSchemaAvroFormat(int peerVersion)