-
- All Implemented Interfaces:
public interface TokenManagerInterface to Manage OAuth2 Tokens
-
-
Method Summary
Modifier and Type Method Description abstract voidpersist(AccessToken token)Persist the AccessToken to storage abstract voidexchangeToken(SSOToken token, Map<String, String> additionalParameters, FRListener<AccessToken> listener)Sends an authorization request to the authorization service. abstract voidexchangeToken(String code, PKCE pkce, Map<String, String> additionalParameters, FRListener<AccessToken> listener)Sends an authorization request to the authorization service. abstract voidrefresh(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. abstract voidgetAccessToken(AccessTokenVerifier accessTokenVerifier, FRListener<AccessToken> tokenListener)Get the AccessToken asynchronously, If the stored AccessToken is expired, auto refresh the token abstract booleanhasToken()Check if token exists in the storage. abstract voidclear()Remove the stored AccessToken abstract voidrevoke(FRListener<Void> listener)OAuth2 Token Revocation -
-
Method Detail
-
persist
abstract void persist(AccessToken token)
Persist the AccessToken to storage
- Parameters:
token- The AccessToken
-
exchangeToken
abstract void exchangeToken(SSOToken token, Map<String, String> additionalParameters, FRListener<AccessToken> listener)
Sends an authorization request to the authorization service.
- Parameters:
token- The SSO Token received with the result of AuthServiceadditionalParameters- Additional parameters for inclusion in the authorization endpointlistener- Listener that listens to changes resulting from OAuth endpoints .
-
exchangeToken
abstract void exchangeToken(String code, PKCE pkce, Map<String, String> additionalParameters, FRListener<AccessToken> listener)
Sends an authorization request to the authorization service.
- Parameters:
code- The Authorization Codepkce- The Proof Key for Code ExchangeadditionalParameters- Additional parameters for inclusion in the token endpoint requestlistener- Listener that listens to changes resulting from OAuth endpoints .
-
refresh
abstract 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.
- Parameters:
accessToken- AccessTokenlistener- Listener to listen for refresh event.
-
getAccessToken
abstract 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
abstract boolean hasToken()
Check if token exists in the storage.
-
clear
abstract void clear()
Remove the stored AccessToken
-
revoke
abstract void revoke(FRListener<Void> listener)
OAuth2 Token Revocation
- Parameters:
listener- Listener to listen for token revocation event.
-
-
-
-