com.azure.android.communication.common

Class CommunicationTokenRefreshOptions

java.lang.Object

com.azure.android.communication.common.CommunicationTokenRefreshOptions

public final class CommunicationTokenRefreshOptions
extends java.lang.Object

Options for refreshing CommunicationTokenCredential

This class is used to define how CommunicationTokenCredential should be refreshed

Constructor Summary

Constructors

Constructor and Description
CommunicationTokenRefreshOptions(java.util.concurrent.Callable<java.lang.String> tokenRefresher, boolean refreshProactively) Creates a CommunicationTokenRefreshOptions object
CommunicationTokenRefreshOptions(java.util.concurrent.Callable<java.lang.String> tokenRefresher, boolean refreshProactively, java.lang.String initialToken) Creates a CommunicationTokenRefreshOptions object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInitialToken()
java.util.concurrent.Callable<java.lang.String>	getTokenRefresher()
boolean	isRefreshProactively()

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunicationTokenRefreshOptions

public CommunicationTokenRefreshOptions(java.util.concurrent.Callable<java.lang.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(java.util.concurrent.Callable<java.lang.String> tokenRefresher,
                                        boolean refreshProactively,
                                        java.lang.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:

java.lang.IllegalArgumentException - if the parameter tokenRefresher or initialToken is null.

Method Detail

getTokenRefresher

public java.util.concurrent.Callable<java.lang.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 java.lang.String getInitialToken()

Returns:

the serialized JWT token