Package io.ably.lib.rest

Class Auth.TokenParams

  • Direct Known Subclasses:
    Auth.TokenRequest
    Enclosing class:
    Auth
    public static class Auth.TokenParams
extends java.lang.Object
    A class providing parameters of a token request.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String capability
      Capability of the token.
      java.lang.String clientId
      A clientId to associate with this token.
      long timestamp
      The timestamp (in millis since the epoch) of this request.
      long ttl
      Requested time to live for the token.

    • Constructor Summary

      Constructors 
      Constructor Description
      TokenParams()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​Param> asMap()
      Internal; convert a TokenParams to a collection of Params
      boolean equals​(java.lang.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 Detail

      • ttl

        public long ttl
        Requested time to live for the token. If the token request is successful, the TTL of the returned token will be less than or equal to this value depending on application settings and the attributes of the issuing key. 0 means Ably will set it to the default value.

      • capability

        public java.lang.String capability
        Capability of the token. If the token request is successful, the capability of the returned token will be the intersection of this capability with the capability of the issuing key.

      • clientId

        public java.lang.String clientId
        A clientId to associate with this token. The generated token may be used to authenticate as this clientId.

      • timestamp

        public long timestamp
        The timestamp (in millis since the epoch) of this request. Timestamps, in conjunction with the nonce, are used to prevent token requests from being replayed.

    • Constructor Detail

      • TokenParams

        public TokenParams()

    • Method Detail

      • asMap

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

      • equals

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