Package io.ably.lib.rest

Class Auth.TokenParams

java.lang.Object
io.ably.lib.rest.Auth.TokenParams
Direct Known Subclasses:
Auth.TokenRequest
Enclosing class:
Auth
public static class Auth.TokenParams extends Object
Defines the properties of an Ably Token.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    String
    capability
    The capabilities associated with this Ably Token.
    String
    clientId
    A client ID, used for identifying this client when publishing messages or for presence purposes.
    long
    timestamp
    The timestamp of this request as milliseconds since the Unix epoch.
    long
    ttl
    Requested time to live for the token in milliseconds.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TokenParams()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Param>
    asMap()
    Internal; convert a TokenParams to a collection of Params
    boolean
    equals(Object obj)
    Check equality of a TokenParams

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ttl

      public long ttl
      Requested time to live for the token in milliseconds. The default is 60 minutes.

      Spec: RSA9e, TK2a

    • capability

      public String capability
      The capabilities associated with this Ably Token. The capabilities value is a JSON-encoded representation of the resource paths and associated operations. Read more about capabilities in the capabilities docs.

      Spec: RSA9f, TK2b

    • clientId

      public String clientId
      A client ID, used for identifying this client when publishing messages or for presence purposes. The clientId can be any non-empty string, except it cannot contain a *. This option is primarily intended to be used in situations where the library is instantiated with a key. Note that a clientId may also be implicit in a token used to instantiate the library. An error is raised if a clientId specified here conflicts with the clientId implicit in the token. Find out more about identified clients.

      Spec: TK2c

    • timestamp

      public long timestamp
      The timestamp of this request as milliseconds since the Unix epoch. Timestamps, in conjunction with the nonce, are used to prevent requests from being replayed. timestamp is a "one-time" value, and is valid in a request, but is not validly a member of any default token params such as ClientOptions.defaultTokenParams.

      Spec: RSA9d, Tk2d

  • Constructor Details

    • TokenParams

      public TokenParams()

  • Method Details

    • asMap

      public Map<String,Param> asMap()
      Internal; convert a TokenParams to a collection of Params
      Returns:

    • equals

      public boolean equals(Object obj)
      Check equality of a TokenParams
      Overrides:
      equals in class Object
      Parameters:
      obj -