Package org.apache.camel.component.pubnub

Class PubNubConfiguration

java.lang.Object
org.apache.camel.component.pubnub.PubNubConfiguration
All Implemented Interfaces:
Cloneable
@UriParams public class PubNubConfiguration extends Object implements Cloneable

  • Constructor Details

    • PubNubConfiguration

      public PubNubConfiguration()

  • Method Details

    • copy

      public PubNubConfiguration copy()

    • getPublishKey

      public String getPublishKey()
      The publish key obtained from your PubNub account. Required when publishing messages.

    • setPublishKey

      public void setPublishKey(String publishKey)

    • getSubscribeKey

      public String getSubscribeKey()
      The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events

    • setSubscribeKey

      public void setSubscribeKey(String subscribeKey)

    • getSecretKey

      public String getSecretKey()
      The secret key used for message signing.

    • setSecretKey

      public void setSecretKey(String secretKey)

    • getAuthKey

      public String getAuthKey()
      If Access Manager is utilized, client will use this authKey in all restricted requests.

    • setAuthKey

      public void setAuthKey(String authKey)

    • getCipherKey

      public String getCipherKey()
      If cipher is passed, all communications to/from PubNub will be encrypted.

    • setCipherKey

      public void setCipherKey(String cipherKey)

    • isSecure

      public boolean isSecure()
      Use SSL for secure transmission.

    • setSecure

      public void setSecure(boolean secure)

    • getChannel

      public String getChannel()
      The channel used for subscribing/publishing events

    • setChannel

      public void setChannel(String channel)

    • setUuid

      public void setUuid(String uuid)
      UUID to be used as a device identifier, a default UUID is generated if not passed.

    • getUuid

      public String getUuid()

    • setOperation

      public void setOperation(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.

    • getOperation

      public String getOperation()

    • setWithPresence

      public void setWithPresence(boolean withPresence)
      Also subscribe to related presence information

    • isWithPresence

      public boolean isWithPresence()