PubnubComponentBuilderFactory.PubnubComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.pubnub.PubNubComponent>

All Known Implementing Classes:

PubnubComponentBuilderFactory.PubnubComponentBuilderImpl

Enclosing interface:

PubnubComponentBuilderFactory
```
public static interface PubnubComponentBuilderFactory.PubnubComponentBuilder
extends ComponentBuilder<org.apache.camel.component.pubnub.PubNubComponent>
```
Builder for the PubNub component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`authKey(String authKey)` If Access Manager is utilized, client will use this authKey in all restricted requests.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`autowiredEnabled(boolean autowiredEnabled)` Whether autowiring is enabled.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`bridgeErrorHandler(boolean 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.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`cipherKey(String cipherKey)` If cipher is passed, all communications to/from PubNub will be encrypted.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`configuration(org.apache.camel.component.pubnub.PubNubConfiguration configuration)` The component configurations.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`operation(String operation)` The operation to perform.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`publishKey(String publishKey)` The publish key obtained from your PubNub account.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`secretKey(String secretKey)` The secret key used for message signing.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`secure(boolean secure)` Use SSL for secure transmission.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`subscribeKey(String subscribeKey)` The subscribe key obtained from your PubNub account.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`uuid(String uuid)` UUID to be used as a device identifier, a default UUID is generated if not passed.
`default PubnubComponentBuilderFactory.PubnubComponentBuilder`	`withPresence(boolean withPresence)` Also subscribe to related presence information.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - configuration
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder configuration(org.apache.camel.component.pubnub.PubNubConfiguration configuration)
```
    The component configurations. The option is a: <code>org.apache.camel.component.pubnub.PubNubConfiguration</code> type. Group: common
    
    Parameters:
    
    configuration - the value to set
    
    Returns:
    
    the dsl builder
  - uuid
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder uuid(String uuid)
```
    UUID to be used as a device identifier, a default UUID is generated if not passed. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    uuid - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder bridgeErrorHandler(boolean 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. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - withPresence
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder withPresence(boolean withPresence)
```
    Also subscribe to related presence information. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    withPresence - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    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. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - operation
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder operation(String 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. WHERENOW: Obtain information about the current list of channels to which a uuid is subscribed to. 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. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - autowiredEnabled
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder autowiredEnabled(boolean 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. The option is a: <code>boolean</code> type. Default: true Group: advanced
    
    Parameters:
    
    autowiredEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - authKey
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder authKey(String authKey)
```
    If Access Manager is utilized, client will use this authKey in all restricted requests. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    authKey - the value to set
    
    Returns:
    
    the dsl builder
  - cipherKey
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder cipherKey(String cipherKey)
```
    If cipher is passed, all communications to/from PubNub will be encrypted. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    cipherKey - the value to set
    
    Returns:
    
    the dsl builder
  - publishKey
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder publishKey(String publishKey)
```
    The publish key obtained from your PubNub account. Required when publishing messages. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    publishKey - the value to set
    
    Returns:
    
    the dsl builder
  - secretKey
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder secretKey(String secretKey)
```
    The secret key used for message signing. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    secretKey - the value to set
    
    Returns:
    
    the dsl builder
  - secure
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder secure(boolean secure)
```
    Use SSL for secure transmission. The option is a: <code>boolean</code> type. Default: true Group: security
    
    Parameters:
    
    secure - the value to set
    
    Returns:
    
    the dsl builder
  - subscribeKey
```
default PubnubComponentBuilderFactory.PubnubComponentBuilder subscribeKey(String subscribeKey)
```
    The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    subscribeKey - the value to set
    
    Returns:
    
    the dsl builder

Interface PubnubComponentBuilderFactory.PubnubComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

configuration

uuid

bridgeErrorHandler

withPresence

lazyStartProducer

operation

autowiredEnabled

authKey

cipherKey

publishKey

secretKey

secure

subscribeKey