org.apache.camel.builder.endpoint.dsl

Interface PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

PubNubEndpointBuilderFactory.PubNubEndpointBuilder

Enclosing interface:

PubNubEndpointBuilderFactory

public static interface PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the PubNub component.

Method Summary

Modifier and Type	Method and Description
default PubNubEndpointBuilderFactory.AdvancedPubNubEndpointConsumerBuilder	advanced()
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	authKey(String authKey) If Access Manager is utilized, client will use this authKey in all restricted requests.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	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 PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	bridgeErrorHandler(String 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 PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	cipherKey(String cipherKey) If cipher is passed, all communications to/from PubNub will be encrypted.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	publishKey(String publishKey) The publish key obtained from your PubNub account.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	secretKey(String secretKey) The secret key used for message signing.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	secure(boolean secure) Use SSL for secure transmission.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	secure(String secure) Use SSL for secure transmission.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	subscribeKey(String subscribeKey) The subscribe key obtained from your PubNub account.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	uuid(String uuid) UUID to be used as a device identifier, a default UUID is generated if not passed.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	withPresence(boolean withPresence) Also subscribe to related presence information.
default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder	withPresence(String withPresence) Also subscribe to related presence information.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default PubNubEndpointBuilderFactory.AdvancedPubNubEndpointConsumerBuilder advanced()

uuid

default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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 PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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

bridgeErrorHandler

default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

withPresence

default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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

withPresence

default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder withPresence(String withPresence)

Also subscribe to related presence information. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

withPresence - the value to set

Returns:

the dsl builder

authKey

default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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 PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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 PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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 PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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 PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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

secure

default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder secure(String secure)

Use SSL for secure transmission. The option will be converted to a <code>boolean</code> type. Default: true Group: security

Parameters:

secure - the value to set

Returns:

the dsl builder

subscribeKey

default PubNubEndpointBuilderFactory.PubNubEndpointConsumerBuilder 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