Package io.ably.lib.types

Class ChannelOptions

java.lang.Object
io.ably.lib.types.ChannelOptions
public class ChannelOptions
extends java.lang.Object
Passes additional properties to a Channel or Channel object, such as encryption, ChannelMode and channel parameters.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.Object cipherParams
    Requests encryption for this channel when not null, and specifies encryption-related parameters (such as algorithm, chaining mode, key length and key).
    boolean encrypted
    Whether or not this ChannelOptions is encrypted.
    ChannelMode[] modes
    An array of ChannelMode objects.
    java.util.Map<java.lang.String,​java.lang.String> params
    Channel Parameters that configure the behavior of the channel.

  • Constructor Summary

    Constructors 
    Constructor Description
    ChannelOptions()  

  • Method Summary

    Modifier and Type Method Description
    static ChannelOptions fromCipherKey​(byte[] key)
    Deprecated.
    static ChannelOptions fromCipherKey​(java.lang.String base64Key)
    Deprecated.
    Crypto.ChannelCipher getCipher()
    Deprecated.
    Since version 1.2.11, this method (which was only ever intended for internal use within this library has been replaced by getCipherSet().
    Crypto.ChannelCipherSet getCipherSet()
    Internal; this method is not intended for use by application developers.
    int getModeFlags()  
    boolean hasModes()  
    boolean hasParams()  
    static ChannelOptions withCipherKey​(byte[] key)
    Constructor withCipherKey, that takes a key only.
    static ChannelOptions withCipherKey​(java.lang.String base64Key)
    Constructor withCipherKey, that takes a key only.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • params

      public java.util.Map<java.lang.String,​java.lang.String> params
      Channel Parameters that configure the behavior of the channel.

      Spec: TB2c

    • modes

      public ChannelMode[] modes
      An array of ChannelMode objects.

      Spec: TB2d

    • cipherParams

      public java.lang.Object cipherParams
      Requests encryption for this channel when not null, and specifies encryption-related parameters (such as algorithm, chaining mode, key length and key). See an example.

      Spec: RSL5a, TB2b

    • encrypted

      public boolean encrypted
      Whether or not this ChannelOptions is encrypted.

  • Constructor Details

  • Method Details

    • hasModes

      public boolean hasModes()

    • hasParams

      public boolean hasParams()

    • getModeFlags

      public int getModeFlags()

    • getCipher

      @Deprecated public Crypto.ChannelCipher getCipher() throws AblyException
      Deprecated.
      Since version 1.2.11, this method (which was only ever intended for internal use within this library has been replaced by getCipherSet(). It will be removed in the future.
      Returns a wrapper around the cipher set to be used for this channel. This wrapper is only available in this API to support customers who may have been using it in their applications with version 1.2.10 or before.
      Throws:
      AblyException

    • getCipherSet

      public Crypto.ChannelCipherSet getCipherSet() throws AblyException
      Internal; this method is not intended for use by application developers. It may be changed or removed in future. Returns the cipher set to be used for encrypting and decrypting data on a channel, given the current state of this instance. On the first call to this method a new cipher set instance is created, with subsequent callers to this method being returned that same cipher set instance. This method is safe to be called from any thread.
      Throws:
      AblyException

    • fromCipherKey

      @Deprecated public static ChannelOptions fromCipherKey​(byte[] key) throws AblyException
      Deprecated.
      Deprecated. Use withCipherKey(byte[]) instead.

      Create ChannelOptions from the given cipher key.
      Parameters:
      key - Byte array cipher key.
      Returns:
      Created ChannelOptions.
      Throws:
      AblyException - If something goes wrong.

    • fromCipherKey

      @Deprecated public static ChannelOptions fromCipherKey​(java.lang.String base64Key) throws AblyException
      Deprecated.
      Deprecated. Use withCipherKey(String) instead.

      Create ChannelOptions from the given cipher key.
      Parameters:
      base64Key - The cipher key as a base64-encoded String,
      Returns:
      Created ChannelOptions.
      Throws:
      AblyException - If something goes wrong.

    • withCipherKey

      public static ChannelOptions withCipherKey​(byte[] key) throws AblyException
      Constructor withCipherKey, that takes a key only.

      Spec: TB3

      Parameters:
      key - A private key used to encrypt and decrypt payloads.
      Returns:
      A ChannelOptions object.
      Throws:
      AblyException - If something goes wrong.

    • withCipherKey

      public static ChannelOptions withCipherKey​(java.lang.String base64Key) throws AblyException
      Constructor withCipherKey, that takes a key only.

      Spec: TB3

      Parameters:
      base64Key - A private key used to encrypt and decrypt payloads.
      Returns:
      A ChannelOptions object.
      Throws:
      AblyException - If something goes wrong.