org.forgerock.android.auth

Interface TokenManager

public interface TokenManager

Interface to Manage OAuth2 Tokens

Method Summary

Modifier and Type	Method and Description
void	clear() Remove the stored AccessToken
void	exchangeToken(SSOToken token, java.util.Map<java.lang.String,java.lang.String> additionalParameters, FRListener<AccessToken> listener) Sends an authorization request to the authorization service.
void	exchangeToken(java.lang.String code, org.forgerock.android.auth.PKCE pkce, java.util.Map<java.lang.String,java.lang.String> additionalParameters, FRListener<AccessToken> listener) Sends an authorization request to the authorization service.
void	getAccessToken(AccessTokenVerifier accessTokenVerifier, FRListener<AccessToken> tokenListener) Get the AccessToken asynchronously,
boolean	hasToken() Check if token exists in the storage.
void	persist(AccessToken token) Persist the AccessToken to storage
void	refresh(AccessToken accessToken, FRListener<AccessToken> listener) Refresh the AccessToken asynchronously, force token refresh, no matter the stored AccessToken is expired or not refresh the token and persist it.
void	revoke(FRListener<java.lang.Void> listener) OAuth2 Token Revocation

Method Detail

persist

void persist(AccessToken token)

Persist the AccessToken to storage

Parameters:

token - The AccessToken

exchangeToken

void exchangeToken(SSOToken token,
                   java.util.Map<java.lang.String,java.lang.String> additionalParameters,
                   FRListener<AccessToken> listener)

Sends an authorization request to the authorization service.

Parameters:

token - The SSO Token received with the result of AuthService

additionalParameters - Additional parameters for inclusion in the authorization endpoint

listener - Listener that listens to changes resulting from OAuth endpoints .

exchangeToken

void exchangeToken(java.lang.String code,
                   org.forgerock.android.auth.PKCE pkce,
                   java.util.Map<java.lang.String,java.lang.String> additionalParameters,
                   FRListener<AccessToken> listener)

Sends an authorization request to the authorization service.

Parameters:

code - The Authorization Code

pkce - The Proof Key for Code Exchange

additionalParameters - Additional parameters for inclusion in the token endpoint request

listener - Listener that listens to changes resulting from OAuth endpoints .

refresh

void refresh(AccessToken accessToken,
             FRListener<AccessToken> listener)
      throws AuthenticationRequiredException

Refresh the AccessToken asynchronously, force token refresh, no matter the stored AccessToken is expired or not refresh the token and persist it.

Parameters:

accessToken - AccessToken

listener - Listener to listen for refresh event.

Throws:

AuthenticationRequiredException - When failed to Refresh the AccessToken

getAccessToken

void getAccessToken(AccessTokenVerifier accessTokenVerifier,
                    FRListener<AccessToken> tokenListener)

Get the AccessToken asynchronously,

If the stored AccessToken is expired, auto refresh the token

Parameters:

accessTokenVerifier - Verifier to verify the access token.

tokenListener - Listener to listen for get access token event.

hasToken

boolean hasToken()

Check if token exists in the storage.

Returns:

True if token exists, otherwise false

clear

void clear()

Remove the stored AccessToken

revoke

void revoke(FRListener<java.lang.Void> listener)

OAuth2 Token Revocation

Parameters:

listener - Listener to listen for token revocation event.