com.microsoft.azure.datalake.store.oauth2

Class DeviceCodeTokenProvider

java.lang.Object

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

com.microsoft.azure.datalake.store.oauth2.DeviceCodeTokenProvider

public class DeviceCodeTokenProvider
extends AccessTokenProvider

Enables interactive login in non-browser based contexts. Displays a message asking the user to login using the browser, using the provided link and code.

Field Summary

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

token

Constructor Summary

Constructors

Constructor and Description
DeviceCodeTokenProvider(String appId) Prompts user to log in and constructs a tokenProvider based on the refresh token obtained from the login.
DeviceCodeTokenProvider(String appId, com.microsoft.azure.datalake.store.oauth2.DeviceCodeCallback callback) Prompts user to log in and constructs a tokenProvider based on the refresh token obtained from the login.

Method Summary

Modifier and Type	Method and Description
String	getRefreshToken()
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

DeviceCodeTokenProvider

public DeviceCodeTokenProvider(String appId)
                        throws IOException

Prompts user to log in and constructs a tokenProvider based on the refresh token obtained from the login.

Parameters:

appId - the app ID whose name Azure AD will display on the login screen

Throws:

IOException - in case of errors

DeviceCodeTokenProvider

public DeviceCodeTokenProvider(String appId,
                               com.microsoft.azure.datalake.store.oauth2.DeviceCodeCallback callback)
                        throws IOException

Prompts user to log in and constructs a tokenProvider based on the refresh token obtained from the login.

Parameters:

appId - the app ID whose name Azure AD will display on the login screen. Can be null. If not provided, a default appId will be used.

callback - callback that can display the message to the user on how to login. Can be null. If not provided, the default callback will be used which diplays the message on standard output.

Throws:

IOException - in case of errors

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

getRefreshToken

public String getRefreshToken()