Package io.ably.lib.types

Class ChannelOptions

  • public class ChannelOptions
extends java.lang.Object

    • Field Detail

      • params

        public java.util.Map<java.lang.String,​java.lang.String> params

      • cipherParams

        public java.lang.Object cipherParams
        Parameters for the cipher.

      • encrypted

        public boolean encrypted
        Whether or not this ChannelOptions is encrypted.

    • Constructor Detail

      • ChannelOptions

        public ChannelOptions()

    • Method Detail

      • 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
        Create ChannelOptions with the given cipher key.
        Parameters:
        key - Byte array cipher key.
        Returns:
        Created ChannelOptions.
        Throws:
        AblyException - If something goes wrong.

      • withCipherKey

        public static ChannelOptions withCipherKey​(java.lang.String base64Key)
                                    throws AblyException
        Create ChannelOptions with the given cipher key.
        Parameters:
        base64Key - The cipher key as a base64-encoded String,
        Returns:
        Created ChannelOptions.
        Throws:
        AblyException - If something goes wrong.