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 15 options, which are listed below.
Name | Description | Default | Required | Priority |
---|---|---|---|---|
camel.source.path.channel |
The channel used for subscribing/publishing events |
null |
true |
HIGH |
camel.source.endpoint.uuid |
UUID to be used as a device identifier, a default UUID is generated if not passed. |
null |
false |
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 |
false |
MEDIUM |
camel.source.endpoint.withPresence |
Also subscribe to related presence information |
false |
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. |
null |
false |
MEDIUM |
camel.source.endpoint.exchangePattern |
Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] |
null |
false |
MEDIUM |
camel.source.endpoint.pubnub |
Reference to a Pubnub client in the registry. |
null |
false |
MEDIUM |
camel.source.endpoint.authKey |
If Access Manager is utilized, client will use this authKey in all restricted requests. |
null |
false |
MEDIUM |
camel.source.endpoint.cipherKey |
If cipher is passed, all communications to/from PubNub will be encrypted. |
null |
false |
MEDIUM |
camel.source.endpoint.publishKey |
The publish key obtained from your PubNub account. Required when publishing messages. |
null |
false |
MEDIUM |
camel.source.endpoint.secretKey |
The secret key used for message signing. |
null |
false |
MEDIUM |
camel.source.endpoint.secure |
Use SSL for secure transmission. |
true |
false |
MEDIUM |
camel.source.endpoint.subscribeKey |
The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events |
null |
false |
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 |
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 |
false |
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.