Package 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 Detail

      • 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

      • 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