Apache Pulsar

Since Camel 2.24

Maven users will need to add the following dependency to their pom.xml for this component.

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-pulsar</artifactId>
    <!-- use the same version as your Camel core version -->
    <version>x.y.z</version>
</dependency>

URI format

pulsar:[persistent|non-persistent]://tenant/namespace/topic

Options

The Apache Pulsar component supports 5 options, which are listed below.

Name Description Default Type

autoConfiguration (common)

The pulsar autoconfiguration

AutoConfiguration

pulsarClient (common)

The pulsar client

PulsarClient

allowManual Acknowledgement (consumer)

Whether to allow manual message acknowledgements. If this option is enabled, then messages are not immediately acknowledged after being consumed. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs.

false

boolean

pulsarMessageReceipt Factory (consumer)

Provide a factory to create an alternate implementation of PulsarMessageReceipt.

PulsarMessageReceipt Factory

resolveProperty Placeholders (advanced)

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

boolean

The Apache Pulsar endpoint is configured using URI syntax:

pulsar:uri

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

topicUri

The Topic’s full URI path including type, tenant and namespace

String

Query Parameters (23 parameters):

Name Description Default Type

ackGroupTimeMillis (consumer)

Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100

100

long

ackTimeoutMillis (consumer)

Timeout for unacknowledged messages in milliseconds - defaults to 10000

10000

long

allowManualAcknowledgement (consumer)

Whether to allow manual message acknowledgements. If this option is enabled, then messages are not immediately acknowledged after being consumed. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs.

false

boolean

bridgeErrorHandler (consumer)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

consumerName (consumer)

Name of the consumer when subscription is EXCLUSIVE

sole-consumer

String

consumerNamePrefix (consumer)

Prefix to add to consumer names when a SHARED or FAILOVER subscription is used

cons

String

consumerQueueSize (consumer)

Size of the consumer queue - defaults to 10

10

int

numberOfConsumers (consumer)

Number of consumers - defaults to 1

1

int

subscriptionName (consumer)

Name of the subscription to use

subs

String

subscriptionType (consumer)

Type of the subscription EXCLUSIVESHAREDFAILOVER, defaults to EXCLUSIVE

EXCLUSIVE

SubscriptionType

exceptionHandler (consumer)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange.

ExchangePattern

batchingEnabled (producer)

Control whether automatic batching of messages is enabled for the producer. Default is true.

true

boolean

batchingMaxMessages (producer)

Set the maximum number of messages permitted in a batch. Default 1,000.

1000

int

batchingMaxPublishDelay Micros (producer)

Set the time period within which the messages sent will be batched if batch messages are enabled. If set to a non zero value, messages will be queued until either: this time interval expires the max number of messages in a batch is reached Default is 1ms.

1000

long

blockIfQueueFull (producer)

Set whether the send and asyncSend operations should block when the outgoing message queue is full. If set to false, send operations will immediately fail with ProducerQueueIsFullError when there is no space left in the pending queue. Default is false.

false

boolean

compressionType (producer)

Set the compression type for the producer. Supported compression types are: NONE: No compression LZ4: Compress with LZ4 algorithm. Faster but lower compression than ZLib ZLI: Standard ZLib compression Default is NONE

NONE

CompressionType

initialSequenceId (producer)

Set the baseline for the sequence ids for messages published by the producer. First message will be using (initialSequenceId 1) as its sequence id and subsequent messages will be assigned incremental sequence ids, if not otherwise specified.

-1

long

maxPendingMessages (producer)

Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker. Default is 1000.

1000

int

maxPendingMessagesAcross Partitions (producer)

Set the number of max pending messages across all the partitions. Default is 50000.

50000

int

producerName (producer)

Name of the producer, if unset lets Pulsar select a unique identifier

String

sendTimeoutMs (producer)

Send timeout in milliseconds. Defaults to 30,000ms (30 seconds)

30000

int

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

Spring Boot Auto-Configuration

When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-pulsar-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 5 options, which are listed below.

Name Description Default Type

camel.component.pulsar.allow-manual-acknowledgement

Whether to allow manual message acknowledgements. If this option is enabled, then messages are not immediately acknowledged after being consumed. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs.

false

Boolean

camel.component.pulsar.enabled

Whether to enable auto configuration of the pulsar component. This is enabled by default.

Boolean

camel.component.pulsar.pulsar-client

The pulsar client. The option is a org.apache.pulsar.client.api.PulsarClient type.

String

camel.component.pulsar.pulsar-message-receipt-factory

Provide a factory to create an alternate implementation of PulsarMessageReceipt. The option is a org.apache.camel.component.pulsar.PulsarMessageReceiptFactory type.

String

camel.component.pulsar.resolve-property-placeholders

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

Boolean

Message headers evaluated by the Pulsar producer

Header Type Description

CamelPulsarProducerMessageKey

String

Sets the key on the message for the Pulsar routing policy

CamelPulsarProducerMessageProperties

Map<String,String>

The properties to set on the Pulsar message

CamelPulsarProducerEventTime

long

Sets the event time on the message

Message headers set by the Pulsar consumer

Header Type Description

properties

Map<String,String>

The properties from the Pulsar message or the empty Map if unset on the Pulsar message

producer_name

String

The name of the producer that created the message

sequence_id

long

Sequence identifier of the Pulsar message

publish_time

long

Time the Pulsar message was published to the topic

message_id

MessageId

Unique identifier of the message

event_time

long

The event time associated with the message or 0 if unset on the Pulsar message

key

String

The key of the Pulsar message in String form or the empty string if unset on the Pulsar message

key_bytes

byte[]

The bytes in the key. If the key has been base64 encoded, it is decoded before being returned. Otherwise, if the key is a plain string, the UTF-8 encoded bytes of the string.

topic_name

String

The topic to which the message was published

manual_acknowledgement

PulsarManualAcknowledgement

If allowManualAcknowledgement is set, this will contain the object for manually acknowledging the Pulsar message; otherwise it is unset
Back to top