Package org.forgerock.android.auth

Class OAuth2Client

java.lang.Object

org.forgerock.android.auth.OAuth2Client

public class OAuth2Client
extends java.lang.Object

Class to handle OAuth2 related endpoint

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OAuth2Client.OAuth2ClientBuilder

Constructor Summary

Constructors

Constructor	Description
OAuth2Client(@NonNull java.lang.String clientId, @NonNull java.lang.String scope, @NonNull java.lang.String redirectUri, @NonNull ServerConfig serverConfig)

Method Summary

Modifier and Type	Method	Description
static OAuth2Client.OAuth2ClientBuilder	builder()
void	endSession(@NonNull java.lang.String idToken, FRListener<java.lang.Void> listener)	End the user session with end session endpoint.
void	exchangeToken(@NonNull SSOToken token, @NonNull java.util.Map<java.lang.String,java.lang.String> additionalParameters, FRListener<AccessToken> listener)	Sends an authorization request to the authorization service.
java.lang.String	getClientId()	The registered client identifier
java.lang.String	getRedirectUri()
java.lang.String	getResponseType()
java.lang.String	getScope()
ServerConfig	getServerConfig()
void	refresh(SSOToken sessionToken, @NonNull java.lang.String refreshToken, FRListener<AccessToken> listener)	Refresh the Access Token with the provided Refresh Token
void	revoke(@NonNull AccessToken accessToken, FRListener<java.lang.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	token(SSOToken sessionToken, @NonNull java.lang.String code, org.forgerock.android.auth.PKCE pkce, java.util.Map<java.lang.String,java.lang.String> additionalParameters, org.forgerock.android.auth.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

Constructor Detail

OAuth2Client

public OAuth2Client(@NonNull
                    @NonNull java.lang.String clientId,
                    @NonNull
                    @NonNull java.lang.String scope,
                    @NonNull
                    @NonNull java.lang.String redirectUri,
                    @NonNull
                    @NonNull ServerConfig serverConfig)

Method Detail

exchangeToken

public void exchangeToken(@NonNull
                          @NonNull SSOToken token,
                          @NonNull
                          @NonNull 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 request

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

refresh

public void refresh(@Nullable
                    SSOToken sessionToken,
                    @NonNull
                    @NonNull java.lang.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

public void revoke(@NonNull
                   @NonNull AccessToken accessToken,
                   FRListener<java.lang.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

public void endSession(@NonNull
                       @NonNull java.lang.String idToken,
                       FRListener<java.lang.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

public void token(@Nullable
                  SSOToken sessionToken,
                  @NonNull
                  @NonNull java.lang.String code,
                  org.forgerock.android.auth.PKCE pkce,
                  java.util.Map<java.lang.String,java.lang.String> additionalParameters,
                  org.forgerock.android.auth.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.

builder

public static OAuth2Client.OAuth2ClientBuilder builder()

getClientId

public java.lang.String getClientId()

The registered client identifier

getScope

public java.lang.String getScope()

getRedirectUri

public java.lang.String getRedirectUri()

getResponseType

public java.lang.String getResponseType()

getServerConfig

public ServerConfig getServerConfig()