Package 

Class OAuth2Client

  • All Implemented Interfaces:

    
    public class OAuth2Client
    
                        

    Class to handle OAuth2 related endpoint

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      void exchangeToken(@NonNull() SSOToken token, @NonNull() Map<String, String> additionalParameters, FRListener<AccessToken> listener) Sends an authorization request to the authorization service.
      void refresh(@Nullable() SSOToken sessionToken, @NonNull() String refreshToken, FRListener<AccessToken> listener) Refresh the Access Token with the provided Refresh Token
      void revoke(@NonNull() AccessToken accessToken, FRListener<Void> listener) Revoke the AccessToken, to revoke the access token, first look for refresh token to revoke, if not provided, will revoke with the access token.
      void endSession(@NonNull() String idToken, FRListener<Void> listener) End the user session with end session endpoint.
      void token(@Nullable() SSOToken sessionToken, @NonNull() String code, PKCE pkce, Map<String, String> additionalParameters, OAuth2ResponseHandler handler, FRListener<AccessToken> listener) Sends an token request to the authorization service.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • exchangeToken

         void exchangeToken(@NonNull() SSOToken token, @NonNull() 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 AuthService
        additionalParameters - Additional parameters for inclusion in the authorization endpoint request
        listener - Listener that listens to changes resulting from OAuth endpoints .
      • refresh

         void refresh(@Nullable() SSOToken sessionToken, @NonNull() String refreshToken, FRListener<AccessToken> listener)

        Refresh the Access Token with the provided Refresh Token

        Parameters:
        sessionToken - The Session Token that bind to existing AccessToken
        refreshToken - The Refresh Token that use to refresh the Access Token
        listener - Listen for endpoint event
      • revoke

         void revoke(@NonNull() AccessToken accessToken, FRListener<Void> listener)

        Revoke the AccessToken, to revoke the access token, first look for refresh token to revoke, if not provided, will revoke with the access token.

        Parameters:
        accessToken - The AccessToken to be revoked
        listener - Listener to listen for revoke event
      • endSession

         void endSession(@NonNull() String idToken, FRListener<Void> listener)

        End the user session with end session endpoint.

        Parameters:
        idToken - The ID_TOKEN which associated with the user session.
        listener - Listener to listen for end session event.
      • token

         void token(@Nullable() SSOToken sessionToken, @NonNull() String code, PKCE pkce, Map<String, String> additionalParameters, OAuth2ResponseHandler handler, FRListener<AccessToken> listener)

        Sends an token request to the authorization service.

        Parameters:
        sessionToken - The Session Token
        code - The Authorization code.
        pkce - The Proof Key for Code Exchange
        additionalParameters - Additional parameters for inclusion in the token endpoint request
        handler - Handle changes resulting from OAuth endpoints.