Package com.azure.android.communication.common

Class CommunicationTokenRefreshOptions

java.lang.Object

com.azure.android.communication.common.CommunicationTokenRefreshOptions

public final class CommunicationTokenRefreshOptions
extends Object

Options for refreshing CommunicationTokenCredential

This class is used to define how CommunicationTokenCredential should be refreshed

Constructor Summary

Constructors

Constructor	Description
CommunicationTokenRefreshOptions(Callable<String> tokenRefresher, boolean refreshProactively)	Creates a CommunicationTokenRefreshOptions object
CommunicationTokenRefreshOptions(Callable<String> tokenRefresher, boolean refreshProactively, String initialToken)	Creates a CommunicationTokenRefreshOptions object

Method Summary

Modifier and Type	Method	Description
String	getInitialToken()
Callable<String>	getTokenRefresher()
boolean	isRefreshProactively()

Methods inherited from class java.lang.Object

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

Constructor Details

CommunicationTokenRefreshOptions

public CommunicationTokenRefreshOptions(Callable<String> tokenRefresher,
 boolean refreshProactively)

Creates a CommunicationTokenRefreshOptions object

Access token will be fetched on demand and may optionally enable proactive refreshing

Parameters:

tokenRefresher - the token refresher to provide capacity to fetch fresh token, cannot be null

refreshProactively - when set to true, turn on proactive fetching to call tokenRefresher before token expiry by minutes set with setCallbackOffsetMinutes or default value of two minutes

CommunicationTokenRefreshOptions

public CommunicationTokenRefreshOptions(Callable<String> tokenRefresher,
 boolean refreshProactively,
 String initialToken)

Creates a CommunicationTokenRefreshOptions object

A valid token is supplied and may optionally enable proactive refreshing

Parameters:

tokenRefresher - the token refresher to provide capacity to fetch fresh token, cannot be null

refreshProactively - when set to true, turn on proactive fetching to call tokenRefresher before token expiry by minutes set with setCallbackOffsetMinutes or default value of two minutes

initialToken - the serialized JWT token, cannot be null

Throws:

IllegalArgumentException - if the parameter tokenRefresher or initialToken is null.

Method Details

getTokenRefresher

public Callable<String> getTokenRefresher()

Returns:

the token refresher to provide capacity to fetch fresh token

isRefreshProactively

public boolean isRefreshProactively()

Returns:

whether or not to refresh token proactively

getInitialToken

public String getInitialToken()

Returns:

the serialized JWT token