Camel Spring Boot Starter for pulsar

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 36 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.auto-configuration

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

String

camel.component.pulsar.basic-property-binding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.pulsar.batcher-builder

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

String

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.

String

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-router

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

String

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-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.

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.send-timeout-ms

Send timeout in milliseconds

30000

Integer

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