org.apache.camel.builder.endpoint.dsl

Interface PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

PubNubEndpointBuilderFactory.PubNubEndpointBuilder

Enclosing interface:

PubNubEndpointBuilderFactory

public static interface PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the PubNub component.

Method Summary

Modifier and Type	Method and Description
default PubNubEndpointBuilderFactory.AdvancedPubNubEndpointProducerBuilder	advanced()
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	authKey(String authKey) If Access Manager is utilized, client will use this authKey in all restricted requests.
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	cipherKey(String cipherKey) If cipher is passed, all communications to/from PubNub will be encrypted.
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	operation(String operation) The operation to perform.
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	publishKey(String publishKey) The publish key obtained from your PubNub account.
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	secretKey(String secretKey) The secret key used for message signing.
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	secure(boolean secure) Use SSL for secure transmission.
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	secure(String secure) Use SSL for secure transmission.
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	subscribeKey(String subscribeKey) The subscribe key obtained from your PubNub account.
default PubNubEndpointBuilderFactory.PubNubEndpointProducerBuilder	uuid(String uuid) UUID to be used as a device identifier, a default UUID is generated if not passed.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default PubNubEndpointBuilderFactory.AdvancedPubNubEndpointProducerBuilder advanced()

uuid

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

lazyStartProducer

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

lazyStartProducer

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

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

operation

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

authKey

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