Package com.amilesend.onedrive.connection.auth

Interface AuthManager

All Known Implementing Classes:

BusinessAccountAuthManager, PersonalAccountAuthManager

public interface AuthManager

The interface that defines the manager that is responsible for obtaining and refreshing tokens to interact with a OneDrive account. Note: This does not manage the initial stages of the OAUTH request flow and instead relies on a provided auth code or a pre-existing refresh token.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_CODE_BODY_ARAM
static final String	AUTH_CODE_GRANT_TYPE_BODY_PARAM_VALUE
static final String	AUTH_TOKEN_URL
static final String	CLIENT_ID_BODY_PARAM
static final String	CLIENT_SECRET_BODY_PARAM
static final String	FORM_DATA_CONTENT_TYPE
static final String	GRANT_TYPE_BODY_PARAM
static final String	REDIRECT_URI_BODY_PARAM
static final String	REFRESH_TOKEN_BODY_PARAM
static final String	REFRESH_TOKEN_GRANT_TYPE_BODY_PARAM_VALUE

Method Summary

Modifier and Type	Method	Description
static AuthInfo	fetchAuthInfo(okhttp3.OkHttpClient httpClient, okhttp3.Request request)	Helper method to dispatch the request to redeem or refresh authorization tokens.
String	getAuthenticatedEndpoint()	Retrieves the associated endpoint to use for OneDrive operations.
AuthInfo	getAuthInfo()	Retrieves the current authentication info.
boolean	isAuthenticated()	Determines if the current authentication information is up-to-date.
boolean	isExpired()	Determines if the current authentication information is expired.
AuthInfo	redeemToken(String authCode)	Issues a request to redeem the given authCode in order to retrieve access and refresh tokens as a AuthInfo.
default void	refreshIfExpired()	Checks to see if the current authentication info is expired and refreshes the tokens accordingly.
default String	refreshIfExpiredAndFetchFullToken()	Helper method to refresh authentication if expired and return the full token used in request headers.
AuthInfo	refreshToken()	Issues a request to refresh the auth tokens and returns the refreshed tokens as a AuthInfo.

Field Details

AUTH_TOKEN_URL

static final String AUTH_TOKEN_URL

See Also:

• Constant Field Values

FORM_DATA_CONTENT_TYPE

static final String FORM_DATA_CONTENT_TYPE

CLIENT_ID_BODY_PARAM

static final String CLIENT_ID_BODY_PARAM

See Also:

• Constant Field Values

CLIENT_SECRET_BODY_PARAM

static final String CLIENT_SECRET_BODY_PARAM

See Also:

• Constant Field Values

REDIRECT_URI_BODY_PARAM

static final String REDIRECT_URI_BODY_PARAM

See Also:

• Constant Field Values

AUTH_CODE_BODY_ARAM

static final String AUTH_CODE_BODY_ARAM

See Also:

• Constant Field Values

REFRESH_TOKEN_BODY_PARAM

static final String REFRESH_TOKEN_BODY_PARAM

See Also:

• Constant Field Values

GRANT_TYPE_BODY_PARAM

static final String GRANT_TYPE_BODY_PARAM

See Also:

• Constant Field Values

AUTH_CODE_GRANT_TYPE_BODY_PARAM_VALUE

static final String AUTH_CODE_GRANT_TYPE_BODY_PARAM_VALUE

See Also:

• Constant Field Values

REFRESH_TOKEN_GRANT_TYPE_BODY_PARAM_VALUE

static final String REFRESH_TOKEN_GRANT_TYPE_BODY_PARAM_VALUE

See Also:

• Constant Field Values

Method Details

isAuthenticated

boolean isAuthenticated()

Determines if the current authentication information is up-to-date.

Returns:

true if authenticated; else, false

isExpired

boolean isExpired()

Determines if the current authentication information is expired.

Returns:

true if expired; else, false

refreshIfExpired

default void refreshIfExpired()

Checks to see if the current authentication info is expired and refreshes the tokens accordingly.

refreshIfExpiredAndFetchFullToken

default String refreshIfExpiredAndFetchFullToken()

Helper method to refresh authentication if expired and return the full token used in request headers.

Returns:

the full auth token

getAuthInfo

AuthInfo getAuthInfo()

Retrieves the current authentication info.

Returns:

the authentication info

See Also:

• AuthInfo

getAuthenticatedEndpoint

String getAuthenticatedEndpoint()

Retrieves the associated endpoint to use for OneDrive operations.

redeemToken

AuthInfo redeemToken(String authCode)

Issues a request to redeem the given authCode in order to retrieve access and refresh tokens as a AuthInfo.

Parameters:

authCode - the authorization code

Returns:

the authorization information

See Also:

• AuthInfo

refreshToken

AuthInfo refreshToken()

Issues a request to refresh the auth tokens and returns the refreshed tokens as a AuthInfo.

Returns:

the authorization information

See Also:

• AuthInfo

fetchAuthInfo

static AuthInfo fetchAuthInfo(okhttp3.OkHttpClient httpClient,
 okhttp3.Request request)

Helper method to dispatch the request to redeem or refresh authorization tokens.

Parameters:

httpClient - the http client

request - the request

Returns:

the authorization information