com.amazonaws.mobileconnectors.cognitoauth

Class AuthClient

java.lang.Object

com.amazonaws.mobileconnectors.cognitoauth.AuthClient

public class AuthClient
extends java.lang.Object

Local client for Auth.

Encapsulates user level operations, tokens AuthUserSession, handles token caching, and token refresh. Manages Cognito-Web user screens.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CUSTOM_TABS_ACTIVITY_CODE A random code the custom tabs activity is launched under.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthClient(android.content.Context context, Auth pool) Constructs AuthClient with no user name.
protected	AuthClient(android.content.Context context, Auth pool, java.lang.String username) Constructs an instance of the Cognito User with username.

Method Summary

Modifier and Type	Method and Description
protected void	getSession(boolean showSignInIfExpired, android.app.Activity activity) Launches user authentication screen and returns a redirect Uri through an Intent.
protected void	getSession(boolean showSignInIfExpired, android.app.Activity activity, java.lang.String browserPackage) Launches user authentication screen and returns a redirect Uri through an Intent.
void	getTokens(android.net.Uri uri) Exchanges code in the Uri for with Cognito JWT.
protected java.lang.String	getUsername()
void	handleCustomTabsCancelled() Properly handles the event where the user cancels out of the custom tabs auth flow either by closing it or navigating back away from it.
boolean	isAuthenticated()
protected void	setUserHandler(AuthHandler handler) Set callback handler for AuthClient.
protected void	setUsername(java.lang.String username) Sets username.
void	signOut() Signs-out a user.
void	signOut(boolean clearLocalTokensOnly) Signs-out a user.
void	signOut(boolean clearLocalTokensOnly, java.lang.String browserPackage) Signs-out a user.
void	signOut(java.lang.String browserPackage) Signs-out a user.
void	unbindServiceConnection() Unbind mCustomTabsServiceConnection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CUSTOM_TABS_ACTIVITY_CODE

public static final int CUSTOM_TABS_ACTIVITY_CODE

A random code the custom tabs activity is launched under. This is needed by clients to listen for the result.

See Also:

Constant Field Values

Constructor Detail

AuthClient

protected AuthClient(android.content.Context context,
                     Auth pool)

Constructs AuthClient with no user name.

Parameters:

context - Required: The android application Context.

pool - Required: A reference to the parent, Auth.

AuthClient

protected AuthClient(android.content.Context context,
                     Auth pool,
                     java.lang.String username)

Constructs an instance of the Cognito User with username.

Parameters:

context - Required: The android application Context.

pool - Required: A reference to the parent, Auth.

username - Required: The username of the user in the Cognito User-Pool.

Method Detail

setUserHandler

protected void setUserHandler(AuthHandler handler)

Set callback handler for AuthClient.

Parameters:

handler - Required: AuthHandler.

setUsername

protected void setUsername(java.lang.String username)

Sets username.

Parameters:

username - Required: Username as a String.

getSession

protected void getSession(boolean showSignInIfExpired,
                          android.app.Activity activity)

Launches user authentication screen and returns a redirect Uri through an Intent.

Checks for cached, valid tokens and launches the Cognito Web UI if no valid tokens are found. This method uses PKCE for authentication. This SDK, therefore, uses code-grant flow to authenticate user. The proof-key and a state is generated and its hash is used in added as query parameters to create the authentication FQDN. The state value set this method is used to temporarily cache the proof-key on the device. To exchange the code for tokens, the Auth.getTokens(Uri) method will use the state in the redirect uri to fetch the stored proof-key.

Parameters:

showSignInIfExpired - true if the web UI should launch when the session is expired

activity - The activity to launch the sign in experience from. This must not be null when showSignInIfExpired is true.

getSession

protected void getSession(boolean showSignInIfExpired,
                          android.app.Activity activity,
                          java.lang.String browserPackage)

Launches user authentication screen and returns a redirect Uri through an Intent.

Checks for cached, valid tokens and launches the Cognito Web UI if no valid tokens are found. This method uses PKCE for authentication. This SDK, therefore, uses code-grant flow to authenticate user. The proof-key and a state is generated and its hash is used in added as query parameters to create the authentication FQDN. The state value set this method is used to temporarily cache the proof-key on the device. To exchange the code for tokens, the Auth.getTokens(Uri) method will use the state in the redirect uri to fetch the stored proof-key.

Parameters:

showSignInIfExpired - true if the web UI should launch when the session is expired

activity - The activity to launch the sign in experience from. This must not be null when showSignInIfExpired is true.

browserPackage - String specifying the browser package to launch the specified url.

getUsername

protected java.lang.String getUsername()

Returns:

Current Username.

signOut

public void signOut()

Signs-out a user.

Clears cached tokens for the user. Launches the sign-out Cognito web end-point to clear all Cognito Auth cookies stored by Chrome.

signOut

public void signOut(java.lang.String browserPackage)

Signs-out a user.

Clears cached tokens for the user. Launches the sign-out Cognito web end-point to clear all Cognito Auth cookies stored by Chrome.

Parameters:

browserPackage - String specifying the browser package to launch the specified url.

signOut

public void signOut(boolean clearLocalTokensOnly)

Signs-out a user.

Clears cached tokens for the user. Launches the sign-out Cognito web end-point to clear all Cognito Auth cookies stored by Chrome.

Parameters:

clearLocalTokensOnly - true if signs out the user from the client, but the session may still be alive from the browser.

signOut

public void signOut(boolean clearLocalTokensOnly,
                    java.lang.String browserPackage)

Signs-out a user.

Launches the sign-out Cognito web end-point to clear all Cognito Auth cookies stored by Chrome. Cached tokens will be deleted if sign-out redirect is completed.

Parameters:

clearLocalTokensOnly - true if signs out the user from the client, but the session may still be alive from the browser.

browserPackage - String specifying the browser package to launch the specified url.

isAuthenticated

public boolean isAuthenticated()

Returns:

true if valid tokens are available for the user.

getTokens

public void getTokens(android.net.Uri uri)

Exchanges code in the Uri for with Cognito JWT.

Checks if the Uri passed to this method is valid. We can avoid a function

Parameters:

uri - Required: The redirect Uri.

handleCustomTabsCancelled

public void handleCustomTabsCancelled()

Properly handles the event where the user cancels out of the custom tabs auth flow either by closing it or navigating back away from it.

unbindServiceConnection

public void unbindServiceConnection()

Unbind mCustomTabsServiceConnection