com.microsoft.azure.datalake.store.oauth2

Class RefreshTokenBasedTokenProvider

java.lang.Object

com.microsoft.azure.datalake.store.oauth2.AccessTokenProvider

com.microsoft.azure.datalake.store.oauth2.RefreshTokenBasedTokenProvider

public class RefreshTokenBasedTokenProvider
extends AccessTokenProvider

Provides tokens based on refresh token

Field Summary

Fields inherited from class com.microsoft.azure.datalake.store.oauth2.AccessTokenProvider

token

Constructor Summary

Constructors

Constructor and Description
RefreshTokenBasedTokenProvider(String refreshToken) constructs a token provider based on the refresh token provided
RefreshTokenBasedTokenProvider(String clientId, RefreshTokenInfo refreshToken) constructs a token provider based on the refresh token provided
RefreshTokenBasedTokenProvider(String clientId, String refreshToken) constructs a token provider based on the refresh token provided

Method Summary

Modifier and Type	Method and Description
protected AzureADToken	refreshToken() the method to fetch the access token.

Methods inherited from class com.microsoft.azure.datalake.store.oauth2.AccessTokenProvider

getToken

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshTokenBasedTokenProvider

public RefreshTokenBasedTokenProvider(String refreshToken)

constructs a token provider based on the refresh token provided

Parameters:

refreshToken - the refresh token

RefreshTokenBasedTokenProvider

public RefreshTokenBasedTokenProvider(String clientId,
                                      String refreshToken)

constructs a token provider based on the refresh token provided

Parameters:

clientId - the client ID (GUID) of the client web app obtained from Azure Active Directory configuration

refreshToken - the refresh token

RefreshTokenBasedTokenProvider

public RefreshTokenBasedTokenProvider(String clientId,
                                      RefreshTokenInfo refreshToken)

constructs a token provider based on the refresh token provided

Parameters:

clientId - the client ID (GUID) of the client web app obtained from Azure Active Directory configuration

refreshToken - the refresh token

Method Detail

refreshToken

protected AzureADToken refreshToken()
                             throws IOException

Description copied from class: AccessTokenProvider

the method to fetch the access token. Derived classes should override this method to actually get the token from Azure Active Directory.

This method will be called initially, and then once when the token is about to expire.

Specified by:

refreshToken in class AccessTokenProvider

Returns:

AzureADToken containing the access token

Throws:

IOException - if there is an error fetching the token