Pulsar

Since Camel 2.24

Both producer and consumer are supported

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

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The Pulsar component supports 41 options, which are listed below.

Name Description Default Type

authenticationClass (common)

The Authentication FQCN to be used while creating the client from URI.

String

authenticationParams (common)

The Authentication Parameters to be used while creating the client from URI.

String

configuration (common)

Allows to pre-configure the Pulsar component with common options that the endpoints will reuse.

PulsarConfiguration

serviceUrl (common)

The Pulsar Service URL to point while creating the client from URI.

String

ackGroupTimeMillis (consumer)

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

long

ackTimeoutMillis (consumer)

Timeout for unacknowledged messages in milliseconds - defaults to 10000.

long

allowManualAcknowledgement (consumer)

Whether to allow manual message acknowledgements. If this option is enabled, then messages are not acknowledged automatically after successful route completion. 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.

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.

boolean

consumerName (consumer)

Name of the consumer when subscription is EXCLUSIVE.

String

consumerNamePrefix (consumer)

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

String

consumerQueueSize (consumer)

Size of the consumer queue - defaults to 10.

int

deadLetterTopic (consumer)

Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ.

String

maxRedeliverCount (consumer)

Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created.

Integer

messageListener (consumer)

Whether to use the messageListener interface, or to receive messages using a separate thread pool.

boolean

negativeAckRedeliveryDelayMicros (consumer)

Set the negative acknowledgement delay.

long

numberOfConsumers (consumer)

Number of consumers - defaults to 1.

int

numberOfConsumerThreads (consumer)

Number of threads to receive and handle messages when using a separate thread pool.

int

readCompacted (consumer)

Enable compacted topic reading.

boolean

subscriptionInitialPosition (consumer)

Control the initial position in the topic of a newly created subscription. Default is latest message.

Enum values:

  • EARLIEST

  • LATEST

SubscriptionInitialPosition

subscriptionName (consumer)

Name of the subscription to use.

String

subscriptionTopicsMode (consumer)

Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions.

Enum values:

  • PersistentOnly

  • NonPersistentOnly

  • AllTopics

RegexSubscriptionMode

subscriptionType (consumer)

Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE.

Enum values:

  • EXCLUSIVE

  • SHARED

  • FAILOVER

  • KEY_SHARED

SubscriptionType

topicsPattern (consumer)

Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace.

boolean

pulsarMessageReceiptFactory (consumer (advanced))

Provide a factory to create an alternate implementation of PulsarMessageReceipt.

PulsarMessageReceiptFactory

batcherBuilder (producer)

Control batching method used by the producer.

BatcherBuilder

batchingEnabled (producer)

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

boolean

batchingMaxMessages (producer)

The maximum size to batch messages.

int

batchingMaxPublishDelayMicros (producer)

The maximum time period within which the messages sent will be batched if batchingEnabled is true.

long

blockIfQueueFull (producer)

Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError.

boolean

compressionType (producer)

Compression type to use.

Enum values:

  • NONE

  • LZ4

  • ZLIB

  • ZSTD

  • SNAPPY

CompressionType

initialSequenceId (producer)

The first message published will have a sequence Id of initialSequenceId 1.

long

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

boolean

maxPendingMessages (producer)

Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true.

int

maxPendingMessagesAcrossPartitions (producer)

The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition.

int

messageRouter (producer)

Custom Message Router to use.

MessageRouter

messageRoutingMode (producer)

Message Routing Mode to use.

Enum values:

  • SinglePartition

  • RoundRobinPartition

  • CustomPartition

MessageRoutingMode

producerName (producer)

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

String

sendTimeoutMs (producer)

Send timeout in milliseconds.

int

autoConfiguration (advanced)

The pulsar auto configuration.

AutoConfiguration

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

boolean

pulsarClient (advanced)

Autowired The pulsar client.

PulsarClient

Endpoint Options

The Pulsar endpoint is configured using URI syntax:

pulsar:persistence://tenant/namespace/topic

with the following path and query parameters:

Path Parameters (4 parameters)

Name Description Default Type

persistence (common)

Required Whether the topic is persistent or non-persistent.

Enum values:

  • persistent

  • non-persistent

String

tenant (common)

Required The tenant.

String

namespace (common)

Required The namespace.

String

topic (common)

Required The topic.

String

Query Parameters (38 parameters)

Name Description Default Type

authenticationClass (common)

The Authentication FQCN to be used while creating the client from URI.

String

authenticationParams (common)

The Authentication Parameters to be used while creating the client from URI.

String

serviceUrl (common)

The Pulsar Service URL to point while creating the client from URI.

String

ackGroupTimeMillis (consumer)

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

long

ackTimeoutMillis (consumer)

Timeout for unacknowledged messages in milliseconds - defaults to 10000.

long

allowManualAcknowledgement (consumer)

Whether to allow manual message acknowledgements. If this option is enabled, then messages are not acknowledged automatically after successful route completion. 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.

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.

boolean

consumerName (consumer)

Name of the consumer when subscription is EXCLUSIVE.

String

consumerNamePrefix (consumer)

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

String

consumerQueueSize (consumer)

Size of the consumer queue - defaults to 10.

int

deadLetterTopic (consumer)

Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ.

String

maxRedeliverCount (consumer)

Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created.

Integer

messageListener (consumer)

Whether to use the messageListener interface, or to receive messages using a separate thread pool.

boolean

negativeAckRedeliveryDelayMicros (consumer)

Set the negative acknowledgement delay.

long

numberOfConsumers (consumer)

Number of consumers - defaults to 1.

int

numberOfConsumerThreads (consumer)

Number of threads to receive and handle messages when using a separate thread pool.

int

readCompacted (consumer)

Enable compacted topic reading.

boolean

subscriptionInitialPosition (consumer)

Control the initial position in the topic of a newly created subscription. Default is latest message.

Enum values:

  • EARLIEST

  • LATEST

SubscriptionInitialPosition

subscriptionName (consumer)

Name of the subscription to use.

String

subscriptionTopicsMode (consumer)

Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions.

Enum values:

  • PersistentOnly

  • NonPersistentOnly

  • AllTopics

RegexSubscriptionMode

subscriptionType (consumer)

Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE.

Enum values:

  • EXCLUSIVE

  • SHARED

  • FAILOVER

  • KEY_SHARED

SubscriptionType

topicsPattern (consumer)

Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace.

boolean

exceptionHandler (consumer (advanced))

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 (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

ExchangePattern

batcherBuilder (producer)

Control batching method used by the producer.

BatcherBuilder

batchingEnabled (producer)

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

boolean

batchingMaxMessages (producer)

The maximum size to batch messages.

int

batchingMaxPublishDelayMicros (producer)

The maximum time period within which the messages sent will be batched if batchingEnabled is true.

long

blockIfQueueFull (producer)

Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError.

boolean

compressionType (producer)

Compression type to use.

Enum values:

  • NONE

  • LZ4

  • ZLIB

  • ZSTD

  • SNAPPY

CompressionType

initialSequenceId (producer)

The first message published will have a sequence Id of initialSequenceId 1.

long

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

boolean

maxPendingMessages (producer)

Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true.

int

maxPendingMessagesAcrossPartitions (producer)

The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition.

int

messageRouter (producer)

Custom Message Router to use.

MessageRouter

messageRoutingMode (producer)

Message Routing Mode to use.

Enum values:

  • SinglePartition

  • RoundRobinPartition

  • CustomPartition

MessageRoutingMode

producerName (producer)

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

String

sendTimeoutMs (producer)

Send timeout in milliseconds.

int

Spring Boot Auto-Configuration

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

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

The component supports 42 options, which are listed below.

Name Description Default Type

camel.component.pulsar.ack-group-time-millis

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

100

Long

camel.component.pulsar.ack-timeout-millis

Timeout for unacknowledged messages in milliseconds - defaults to 10000.

10000

Long

camel.component.pulsar.allow-manual-acknowledgement

Whether to allow manual message acknowledgements. If this option is enabled, then messages are not acknowledged automatically after successful route completion. 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.authentication-class

The Authentication FQCN to be used while creating the client from URI.

String

camel.component.pulsar.authentication-params

The Authentication Parameters to be used while creating the client from URI.

String

camel.component.pulsar.auto-configuration

The pulsar auto configuration. The option is a org.apache.camel.component.pulsar.utils.AutoConfiguration type.

AutoConfiguration

camel.component.pulsar.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.pulsar.batcher-builder

Control batching method used by the producer. The option is a org.apache.pulsar.client.api.BatcherBuilder type.

BatcherBuilder

camel.component.pulsar.batching-enabled

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

true

Boolean

camel.component.pulsar.batching-max-messages

The maximum size to batch messages.

1000

Integer

camel.component.pulsar.batching-max-publish-delay-micros

The maximum time period within which the messages sent will be batched if batchingEnabled is true.

1000

Long

camel.component.pulsar.block-if-queue-full

Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError.

false

Boolean

camel.component.pulsar.bridge-error-handler

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

camel.component.pulsar.compression-type

Compression type to use.

CompressionType

camel.component.pulsar.configuration

Allows to pre-configure the Pulsar component with common options that the endpoints will reuse. The option is a org.apache.camel.component.pulsar.PulsarConfiguration type.

PulsarConfiguration

camel.component.pulsar.consumer-name

Name of the consumer when subscription is EXCLUSIVE.

sole-consumer

String

camel.component.pulsar.consumer-name-prefix

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

cons

String

camel.component.pulsar.consumer-queue-size

Size of the consumer queue - defaults to 10.

10

Integer

camel.component.pulsar.dead-letter-topic

Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ.

String

camel.component.pulsar.enabled

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

Boolean

camel.component.pulsar.initial-sequence-id

The first message published will have a sequence Id of initialSequenceId 1.

-1

Long

camel.component.pulsar.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.pulsar.max-pending-messages

Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true.

1000

Integer

camel.component.pulsar.max-pending-messages-across-partitions

The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition.

50000

Integer

camel.component.pulsar.max-redeliver-count

Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created.

Integer

camel.component.pulsar.message-listener

Whether to use the messageListener interface, or to receive messages using a separate thread pool.

true

Boolean

camel.component.pulsar.message-router

Custom Message Router to use. The option is a org.apache.pulsar.client.api.MessageRouter type.

MessageRouter

camel.component.pulsar.message-routing-mode

Message Routing Mode to use.

MessageRoutingMode

camel.component.pulsar.negative-ack-redelivery-delay-micros

Set the negative acknowledgement delay.

60000000

Long

camel.component.pulsar.number-of-consumer-threads

Number of threads to receive and handle messages when using a separate thread pool.

1

Integer

camel.component.pulsar.number-of-consumers

Number of consumers - defaults to 1.

1

Integer

camel.component.pulsar.producer-name

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

String

camel.component.pulsar.pulsar-client

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

PulsarClient

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.

PulsarMessageReceiptFactory

camel.component.pulsar.read-compacted

Enable compacted topic reading.

false

Boolean

camel.component.pulsar.send-timeout-ms

Send timeout in milliseconds.

30000

Integer

camel.component.pulsar.service-url

The Pulsar Service URL to point while creating the client from URI.

String

camel.component.pulsar.subscription-initial-position

Control the initial position in the topic of a newly created subscription. Default is latest message.

SubscriptionInitialPosition

camel.component.pulsar.subscription-name

Name of the subscription to use.

subs

String

camel.component.pulsar.subscription-topics-mode

Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions.

RegexSubscriptionMode

camel.component.pulsar.subscription-type

Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE.

SubscriptionType

camel.component.pulsar.topics-pattern

Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace.

false

Boolean