Class PersonalAccountAuthManager
java.lang.Object
com.amilesend.onedrive.connection.auth.PersonalAccountAuthManager
- All Implemented Interfaces:
com.amilesend.client.connection.auth.AuthManager<OneDriveAuthInfo>, OneDriveAuthManager
Manager that is responsible for obtaining and refreshing tokens to interact with a personal
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.
Example initializing with an auth code:
PersonalAccountAuthManager.builderWithAuthCode()
.httpClient(client) // the OKHttpClient instance
.gsonFactory(gsonFactory) // preconfigured Gson instances
.clientId(clientId) // the client ID of your application
.clientSecret(clientSecret) // the client secret of your application
.redirectUrl(redirectUrl) // the redirect URL for OAUTH flow
.authCode(authCode) // The obtained auth code from initial OAUTH handshake
.buildWithAuthCode();
Example initializing with an AuthInfo (pre-existing refresh token):
PersonalAccountAuthManager.builderWithAuthInfo()
.httpClient(client)
.gsonFactory(gsonFactory)
.clientId(clientId)
.clientSecret(clientSecret)
.redirectUrl(redirectUrl)
.authInfo(authInfo) // Instead of an auth code, an AuthInfo object is used to obtain the refresh token
.buildWithAuthInfo();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic class -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves the associated endpoint to use for OneDrive operations.booleanbooleanDetermines if the current authentication information is expired.redeemToken(String authCode) Issues a request to redeem the givenauthCodein order to retrieve access and refresh tokens as aOneDriveAuthInfo.Issues a request to refresh the auth tokens and returns the refreshed tokens as aOneDriveAuthInfo.Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface OneDriveAuthManager
addAuthentication, refreshIfExpired, refreshIfExpiredAndFetchFullToken
-
Method Details
-
isAuthenticated
public boolean isAuthenticated()- Specified by:
isAuthenticatedin interfacecom.amilesend.client.connection.auth.AuthManager<OneDriveAuthInfo>
-
isExpired
public boolean isExpired()Description copied from interface:OneDriveAuthManagerDetermines if the current authentication information is expired.- Specified by:
isExpiredin interfaceOneDriveAuthManager- Returns:
trueif expired; else,false
-
getAuthInfo
- Specified by:
getAuthInfoin interfacecom.amilesend.client.connection.auth.AuthManager<OneDriveAuthInfo>
-
getAuthenticatedEndpoint
Description copied from interface:OneDriveAuthManagerRetrieves the associated endpoint to use for OneDrive operations.- Specified by:
getAuthenticatedEndpointin interfaceOneDriveAuthManager
-
redeemToken
Description copied from interface:OneDriveAuthManagerIssues a request to redeem the givenauthCodein order to retrieve access and refresh tokens as aOneDriveAuthInfo.- Specified by:
redeemTokenin interfaceOneDriveAuthManager- Parameters:
authCode- the authorization code- Returns:
- the authorization information
- See Also:
-
refreshToken
Description copied from interface:OneDriveAuthManagerIssues a request to refresh the auth tokens and returns the refreshed tokens as aOneDriveAuthInfo.- Specified by:
refreshTokenin interfaceOneDriveAuthManager- Returns:
- the authorization information
- See Also:
-
builderWithAuthCode
-
builderWithAuthInfo
-