```
public class Auth

                    
```
Token-generation and authentication operations for the Ably API. See the Ably Authentication documentation for details of the authentication methods available. Creates Ably TokenRequest objects and obtains Ably Tokens from Ably to subsequently issue to less trusted clients.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`Auth.AuthMethod`	Authentication methods
`public class`	`Auth.AuthOptions`	Passes authentication-specific properties in authentication requests to Ably.Properties set using AuthOptions are used instead of the default values set when the client libraryis instantiated, as opposed to being merged with them.
`public class`	`Auth.TokenDetails`	Contains an Ably Token and its associated metadata.
`public class`	`Auth.TokenParams`	Defines the properties of an Ably Token.
`public class`	`Auth.TokenRequest`	Contains the properties of a request for a token to Ably.Tokens are generated using requestToken.
`public interface`	`Auth.AuthUpdateResult`	An interface providing update result for onAuthUpdated
`public interface`	`Auth.RenewAuthResult`	An interface providing completion callbackk for renewAuth
`public interface`	`Auth.TokenCallback`	An interface implemented by a callback that provides either tokens,or signed token requests, in response to a request with given token params.

Field Summary

Fields
Modifier and Type	Field	Description
`public String`	`clientId`
`private Auth.AuthOptions`	`authOptions`
`private String`	`basicCredentials`
`private Auth.TokenDetails`	`tokenDetails`
`private String`	`encodedToken`
`public final static String`	`WILDCARD_CLIENTID`

Method Summary

Modifier and Type	Method	Description
`void`	`setClientId(String clientId)`	Set the clientId, after first initialisation in the construction of the librarytherefore an existing null value is significant - it means that ClientOptions.
`Auth.AuthOptions`	`getAuthOptions()`	Get (a copy of) auth options currently set in this Auth.
`String`	`getBasicCredentials()`	Get the credentials for HTTP basic auth, if available.
`Auth.TokenDetails`	`getTokenDetails()`
`void`	`setTokenDetails(String token)`
`String`	`getEncodedToken()`
`Auth.TokenDetails`	`authorize(Auth.TokenParams params, Auth.AuthOptions options)`	Instructs the library to get a new token immediately.When using the realtime client, it upgrades the current realtime connection to use the new token,or if not connected, initiates a connection to Ably, once the new token has been obtained.
`Auth.TokenDetails`	`authorise(Auth.TokenParams params, Auth.AuthOptions options)`	Alias of authorize() (0.
`Auth.TokenDetails`	`requestToken(Auth.TokenParams params, Auth.AuthOptions tokenOptions)`	Calls the requestToken REST API endpoint to obtain an Ably Tokenaccording to the specified TokenParams and AuthOptions.
`Auth.TokenRequest`	`createTokenRequest(Auth.TokenParams params, Auth.AuthOptions options)`	Creates and signs an Ably TokenRequest based on the specified(or if none specified, the client library stored) TokenParams and AuthOptions.Note this can only be used when the API key value is available locally.
`Auth.AuthMethod`	`getAuthMethod()`	Get the authentication method for this library instance.
`Array<Param>`	`getAuthParams()`	Get query params representing the current authentication method and credentials.
`Auth.TokenDetails`	`renew()`	Renew auth credentials.Will obtain a new token, even if we already have an apparently valid one.Authorization will use the parameters supplied on construction.
`void`	`renewAuth(Auth.RenewAuthResult result)`	Renew auth credentials.Will obtain a new token, even if we already have an apparently valid one.Authorization will use the parameters supplied on construction.
`void`	`onAuthError(ErrorInfo err)`
`static long`	`timestamp()`
`Auth.TokenDetails`	`assertValidToken()`
`void`	`assertAuthorizationHeader(boolean forceRenew)`	Get the Authorization header, forcing the creation of a new token if requested
`String`	`getAuthorizationHeader()`
`String`	`checkClientId(BaseMessage msg, boolean allowNullClientId, boolean connected)`	Verify that a message, possibly containing a clientId,is compatible with Auth.
`long`	`serverTimestamp()`	Using time delta obtained before guess current server time
`void`	`clearCachedServerTime()`	For testing purposes we need method to clear cached timeDelta

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setClientId
```
 void setClientId(String clientId)
```
    Set the clientId, after first initialisation in the construction of the librarytherefore an existing null value is significant - it means that ClientOptions.clientIdwas null
  - getAuthOptions
```
 Auth.AuthOptions getAuthOptions()
```
    Get (a copy of) auth options currently set in this Auth.
  - getBasicCredentials
```
 String getBasicCredentials()
```
    Get the credentials for HTTP basic auth, if available.
  - getTokenDetails
```
 Auth.TokenDetails getTokenDetails()
```
  - setTokenDetails
```
 void setTokenDetails(String token)
```
  - getEncodedToken
```
 String getEncodedToken()
```
  - authorize
```
 Auth.TokenDetails authorize(Auth.TokenParams params, Auth.AuthOptions options)
```
    Instructs the library to get a new token immediately.When using the realtime client, it upgrades the current realtime connection to use the new token,or if not connected, initiates a connection to Ably, once the new token has been obtained.Also stores any TokenParams and AuthOptions passed in as the new defaults,to be used for all subsequent implicit or explicit token requests.Any TokenParams and AuthOptions objects passed in entirely replace,as opposed to being merged with, the current client library saved values.
    Spec: RSA10
    
    Parameters:
    
    params - A TokenParams object.
    
    options - An AuthOptions object.
  - authorise
```
@Deprecated() Auth.TokenDetails authorise(Auth.TokenParams params, Auth.AuthOptions options)
```
    Alias of authorize() (0.9 RSA10l)
  - requestToken
```
 Auth.TokenDetails requestToken(Auth.TokenParams params, Auth.AuthOptions tokenOptions)
```
    Calls the requestToken REST API endpoint to obtain an Ably Tokenaccording to the specified TokenParams and AuthOptions.Both TokenParams and AuthOptions are optional.When omitted or null, the default token parameters and authentication options for the client library are used,as specified in the ClientOptions when the client library was instantiated,or later updated with an explicit authorize request. Values passed in are used instead of,rather than being merged with, the default values.To understand why an Ably TokenRequest may be issued to clients in favor of a token,see Token Authentication explained.
    Spec: RSA8e
    
    Parameters:
    
    params - : A TokenParams object.
    
    tokenOptions - : An AuthOptions object.
  - createTokenRequest
```
 Auth.TokenRequest createTokenRequest(Auth.TokenParams params, Auth.AuthOptions options)
```
    Creates and signs an Ably TokenRequest based on the specified(or if none specified, the client library stored) TokenParams and AuthOptions.Note this can only be used when the API key value is available locally.Otherwise, the Ably TokenRequest must be obtained from the key owner.Use this to generate an Ably TokenRequest in order to implement anAbly Token request callback for use by other clients. Both TokenParams and AuthOptions are optional.When omitted or null, the default token parameters and authentication options for the client library are used,as specified in the ClientOptions when the client library was instantiated,or later updated with an explicit authorize request.Values passed in are used instead of, rather than being merged with, the default values.To understand why an Ably TokenRequest may be issued to clients in favor of a token,see Token Authentication explained.
    Spec: RSA9
    
    Parameters:
    
    params - : A TokenParams object.
    
    options - : An AuthOptions object.
  - getAuthMethod
```
 Auth.AuthMethod getAuthMethod()
```
    Get the authentication method for this library instance.
  - getAuthParams
```
 Array<Param> getAuthParams()
```
    Get query params representing the current authentication method and credentials.
  - renew
```
@Deprecated() Auth.TokenDetails renew()
```
    Renew auth credentials.Will obtain a new token, even if we already have an apparently valid one.Authorization will use the parameters supplied on construction.
  - renewAuth
```
 void renewAuth(Auth.RenewAuthResult result)
```
    Renew auth credentials.Will obtain a new token, even if we already have an apparently valid one.Authorization will use the parameters supplied on construction.
    
    Parameters:
    
    result - Asynchronous result the completionPlease note that completion callback onCompletion is called on a background thread.
  - onAuthError
```
 void onAuthError(ErrorInfo err)
```
  - timestamp
```
 static long timestamp()
```
  - assertValidToken
```
 Auth.TokenDetails assertValidToken()
```
  - assertAuthorizationHeader
```
 void assertAuthorizationHeader(boolean forceRenew)
```
    Get the Authorization header, forcing the creation of a new token if requested
  - getAuthorizationHeader
```
 String getAuthorizationHeader()
```
  - checkClientId
```
 String checkClientId(BaseMessage msg, boolean allowNullClientId, boolean connected)
```
    Verify that a message, possibly containing a clientId,is compatible with Auth.clientId if it is set
    
    Parameters:
    
    allowNullClientId - true if it is ok for there to be no resolved clientId
    
    connected - true if connected; if false it is ok for the library to be unidentified
  - serverTimestamp
```
 long serverTimestamp()
```
    Using time delta obtained before guess current server time
  - clearCachedServerTime
```
 void clearCachedServerTime()
```
    For testing purposes we need method to clear cached timeDelta

Class Auth

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setClientId

getAuthOptions

getBasicCredentials

getTokenDetails

setTokenDetails

getEncodedToken

authorize

authorise

requestToken

createTokenRequest

getAuthMethod

getAuthParams

renew

renewAuth

onAuthError

timestamp

assertValidToken

assertAuthorizationHeader

getAuthorizationHeader

checkClientId

serverTimestamp

clearCachedServerTime