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

      • 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

      • 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