| // kafka-connector options: START |
| [[camel-pubnub-kafka-connector-source]] |
| = camel-pubnub-kafka-connector source configuration |
| |
| When using camel-pubnub-kafka-connector as source make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <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> |
| ---- |
| |
| |
| The camel-pubnub source connector supports 17 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.channel* | The channel used for subscribing/publishing events | null | ConfigDef.Importance.HIGH |
| | *camel.source.endpoint.uuid* | UUID to be used as a device identifier, a default UUID is generated if not passed. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.with Presence* | Also subscribe to related presence information | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.exception Handler* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.pubnub* | Reference to a Pubnub client in the registry. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.authKey* | If Access Manager is utilized, client will use this authKey in all restricted requests. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.cipher Key* | If cipher is passed, all communications to/from PubNub will be encrypted. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.publish Key* | The publish key obtained from your PubNub account. Required when publishing messages. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.secret Key* | The secret key used for message signing. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.secure* | Use SSL for secure transmission. | true | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.subscribe Key* | The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.pubnub.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.component.pubnub.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
