camel-pubnub-kafka-connector source configuration

Connector Description: Send and receive messages to/from PubNub data stream network for connected devices.

When using camel-pubnub-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-pubnub-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.pubnub.CamelPubnubSourceConnector

The camel-pubnub source connector supports 24 options, which are listed below.

Name Description Default Priority

camel.source.path.channel

Required The channel used for subscribing/publishing events.

HIGH

camel.source.endpoint.uuid

UUID to be used as a device identifier, a default UUID is generated if not passed.

MEDIUM

camel.source.endpoint.bridgeErrorHandler

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

MEDIUM

camel.source.endpoint.withPresence

Also subscribe to related presence information.

false

MEDIUM

camel.source.endpoint.exceptionHandler

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.

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut].

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.pubnub

Reference to a Pubnub client in the registry.

MEDIUM

camel.source.endpoint.authKey

If Access Manager is utilized, client will use this authKey in all restricted requests.

MEDIUM

camel.source.endpoint.cipherKey

If cipher is passed, all communications to/from PubNub will be encrypted.

MEDIUM

camel.source.endpoint.publishKey

The publish key obtained from your PubNub account. Required when publishing messages.

MEDIUM

camel.source.endpoint.secretKey

The secret key used for message signing.

MEDIUM

camel.source.endpoint.secure

Use SSL for secure transmission.

true

MEDIUM

camel.source.endpoint.subscribeKey

The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events.

MEDIUM

camel.component.pubnub.configuration

The component configurations.

MEDIUM

camel.component.pubnub.uuid

UUID to be used as a device identifier, a default UUID is generated if not passed.

MEDIUM

camel.component.pubnub.bridgeErrorHandler

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

MEDIUM

camel.component.pubnub.withPresence

Also subscribe to related presence information.

false

MEDIUM

camel.component.pubnub.autowiredEnabled

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

MEDIUM

camel.component.pubnub.authKey

If Access Manager is utilized, client will use this authKey in all restricted requests.

MEDIUM

camel.component.pubnub.cipherKey

If cipher is passed, all communications to/from PubNub will be encrypted.

MEDIUM

camel.component.pubnub.publishKey

The publish key obtained from your PubNub account. Required when publishing messages.

MEDIUM

camel.component.pubnub.secretKey

The secret key used for message signing.

MEDIUM

camel.component.pubnub.secure

Use SSL for secure transmission.

true

MEDIUM

camel.component.pubnub.subscribeKey

The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events.

MEDIUM

The camel-pubnub source connector has no converters out of the box.

The camel-pubnub source connector has no transforms out of the box.

The camel-pubnub source connector has no aggregation strategies out of the box.