PubNub

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

What’s inside

PubNub component, URI syntax: pubnub:channel

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-pubnub-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 13 options, which are listed below.

Name	Description	Default	Type
camel.component.pubnub.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.pubnub.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.pubnub.configuration	The component configurations. The option is a org.apache.camel.component.pubnub.PubNubConfiguration type.		PubNubConfiguration
camel.component.pubnub.enabled	Whether to enable auto configuration of the pubnub component. This is enabled by default.		Boolean
camel.component.pubnub.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.pubnub.operation	The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. GETSTATE: Used to get key/value pairs specific to a subscriber uuid. State information is supplied as a JSON object of key/value pairs SETSTATE: Used to set key/value pairs specific to a subscriber uuid GETHISTORY: Fetches historical messages of a channel.		String
camel.component.pubnub.publish-key	The publish key obtained from your PubNub account. Required when publishing messages.		String
camel.component.pubnub.secret-key	The secret key used for message signing.		String
camel.component.pubnub.secure	Use SSL for secure transmission.	true	Boolean
camel.component.pubnub.subscribe-key	The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events		String
camel.component.pubnub.uuid	UUID to be used as a device identifier, a default UUID is generated if not passed.		String
camel.component.pubnub.with-presence	Also subscribe to related presence information	false	Boolean
camel.component.pubnub.auth-key	If Access Manager is utilized, client will use this authKey in all restricted requests. Default value notice: This setting is deprecated because it relates to deprecated Access Manager (PAM V2) and will be removed in the future. Please, migrate to new Access Manager (PAM V3) https://www.pubnub.com/docs/general/resources/migration-guides/pam-v3-migration		String

Name

Description

Default

Type

camel.component.pubnub.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.pubnub.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.pubnub.configuration

The component configurations. The option is a org.apache.camel.component.pubnub.PubNubConfiguration type.

PubNubConfiguration

camel.component.pubnub.enabled

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

Boolean

camel.component.pubnub.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.pubnub.operation

The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. GETSTATE: Used to get key/value pairs specific to a subscriber uuid. State information is supplied as a JSON object of key/value pairs SETSTATE: Used to set key/value pairs specific to a subscriber uuid GETHISTORY: Fetches historical messages of a channel.

String

camel.component.pubnub.publish-key

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

String

camel.component.pubnub.secret-key

The secret key used for message signing.

String

camel.component.pubnub.secure

Use SSL for secure transmission.

true

Boolean

camel.component.pubnub.subscribe-key

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

String

camel.component.pubnub.uuid

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

String

camel.component.pubnub.with-presence

Also subscribe to related presence information

false

Boolean

camel.component.pubnub.auth-key

If Access Manager is utilized, client will use this authKey in all restricted requests. Default value notice: This setting is deprecated because it relates to deprecated Access Manager (PAM V2) and will be removed in the future. Please, migrate to new Access Manager (PAM V3) https://www.pubnub.com/docs/general/resources/migration-guides/pam-v3-migration

String