com.amazonaws.mobile.client

Class AWSMobileClient

java.lang.Object

com.amazonaws.mobile.client.AWSMobileClient

All Implemented Interfaces:

AWSCredentialsProvider

public final class AWSMobileClient
extends java.lang.Object
implements AWSCredentialsProvider

The AWSMobileClient provides client APIs and building blocks for developers who want to create user authentication experiences. This includes declarative methods for performing authentication actions, a simple “drop-in auth” UI for performing common tasks, automatic token and credentials management, and state tracking with notifications for performing workflows in your application when users have authenticated. The following demonstrates a simple sample usage inside of MainActivity.java onCreate method.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     public void onResult(UserStateDetails userStateDetails) {
         switch (userStateDetails.getUserState()) {
             case SIGNED_IN:
                 break;
             case SIGNED_OUT:
                 try {
                     AWSMobileClient.getInstance().showSignIn(MainActivity.this);
                 } catch (Exception e) {
                     Log.e("TAG", "", e);
                 }
                 break;
             default:
                 Log.w("Unhandled state see UserState for a list of states");
                 break;
         }
     }
 })
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AWSMobileClient.InitializeBuilder Deprecated. Since 2.8.0 This method will be removed in the next minor version. Please update to use AWSMobileClient using `initialize`. Please visit https://aws-amplify.github.io for the latest Android documentation.
class	AWSMobileClient.SignInProviderConfig Deprecated. Since 2.8.0 This method will be removed in the next minor version. Please update to use AWSMobileClient using `initialize`. Please visit https://aws-amplify.github.io for the latest Android documentation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHALLENGE_RESPONSE_NEW_PASSWORD_KEY
static java.lang.String	CHALLENGE_RESPONSE_USER_ATTRIBUTES_PREFIX_KEY
static java.lang.String	DEFAULT_USER_AGENT
static java.lang.String	HOSTED_UI_KEY

Method Summary

Modifier and Type	Method and Description
void	addUserStateListener(UserStateListener listener) Adds a listener to be notified of state changes.
void	changePassword(java.lang.String oldPassword, java.lang.String newPassword)
void	changePassword(java.lang.String oldPassword, java.lang.String newPassword, Callback<java.lang.Void> callback)
ForgotPasswordResult	confirmForgotPassword(java.lang.String password, java.util.Map<java.lang.String,java.lang.String> clientMetadata, java.lang.String forgotPasswordChallengeResponse) Second method to call after forgotPassword(String) to respond to any challenges that the service may request.
ForgotPasswordResult	confirmForgotPassword(java.lang.String password, java.lang.String forgotPasswordChallengeResponse) Second method to call after forgotPassword(String) to respond to any challenges that the service may request.
void	confirmForgotPassword(java.lang.String password, java.lang.String forgotPasswordChallengeResponse, Callback<ForgotPasswordResult> callback) Second method to call after forgotPassword(String) to respond to any challenges that the service may request.
void	confirmForgotPassword(java.lang.String password, java.lang.String forgotPasswordChallengeResponse, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<ForgotPasswordResult> callback) Second method to call after forgotPassword(String) to respond to any challenges that the service may request.
SignInResult	confirmSignIn(java.util.Map<java.lang.String,java.lang.String> signInChallengeResponse) The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>).
void	confirmSignIn(java.util.Map<java.lang.String,java.lang.String> signInChallengeResponse, Callback<SignInResult> callback) The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>).
SignInResult	confirmSignIn(java.util.Map<java.lang.String,java.lang.String> signInChallengeResponse, java.util.Map<java.lang.String,java.lang.String> clientMetaData) The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>).
void	confirmSignIn(java.util.Map<java.lang.String,java.lang.String> signInChallengeResponse, java.util.Map<java.lang.String,java.lang.String> clientMetaData, Callback<SignInResult> callback) The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>).
SignInResult	confirmSignIn(java.lang.String signInChallengeResponse)
void	confirmSignIn(java.lang.String signInChallengeResponse, Callback<SignInResult> callback)
SignInResult	confirmSignIn(java.lang.String signInChallengeResponse, java.util.Map<java.lang.String,java.lang.String> clientMetadata)
void	confirmSignIn(java.lang.String signInChallengeResponse, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<SignInResult> callback)
SignUpResult	confirmSignUp(java.lang.String username, java.lang.String signUpChallengeResponse) Confirm the sign-up request with follow-up information
void	confirmSignUp(java.lang.String username, java.lang.String signUpChallengeResponse, Callback<SignUpResult> callback) Confirm the sign-up request with follow-up information
SignUpResult	confirmSignUp(java.lang.String username, java.lang.String signUpChallengeResponse, java.util.Map<java.lang.String,java.lang.String> clientMetadata) Confirm the sign-up request with follow-up information
void	confirmSignUp(java.lang.String username, java.lang.String signUpChallengeResponse, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<SignUpResult> callback) Confirm the sign-up request with follow-up information
void	confirmUpdateUserAttribute(java.lang.String attributeName, java.lang.String updateUserAttributeChallengeResponse) Confirm the attribute with the code provided by user.
void	confirmUpdateUserAttribute(java.lang.String attributeName, java.lang.String updateUserAttributeChallengeResponse, Callback<java.lang.Void> callback) Confirm the attribute with the code provided by user.
void	confirmVerifyUserAttribute(java.lang.String attributeName, java.lang.String updateUserAttributeChallengeResponse) Confirm the attribute with the code provided by user.
void	confirmVerifyUserAttribute(java.lang.String attributeName, java.lang.String updateUserAttributeChallengeResponse, Callback<java.lang.Void> callback) Confirm the attribute with the code provided by user.
UserStateDetails	currentUserState() Performs a check on the current UserState.
void	currentUserState(Callback<UserStateDetails> callback) Performs a check on the current UserState.
UserStateDetails	federatedSignIn(java.lang.String providerKey, java.lang.String token) Federate tokens from custom identity providers into Cognito Identity Pool by providing the logins key and token
void	federatedSignIn(java.lang.String providerKey, java.lang.String token, Callback<UserStateDetails> callback) Federate tokens from custom identity providers into Cognito Identity Pool by providing the logins key and token
UserStateDetails	federatedSignIn(java.lang.String providerKey, java.lang.String token, FederatedSignInOptions options) Federate tokens from custom identity providers by providing the logins key and token
void	federatedSignIn(java.lang.String providerKey, java.lang.String token, FederatedSignInOptions options, Callback<UserStateDetails> callback) Federate tokens from custom identity providers by providing the logins key and token
ForgotPasswordResult	forgotPassword(java.lang.String username) Used to reset password if user forgot the old password.
void	forgotPassword(java.lang.String username, Callback<ForgotPasswordResult> callback) Used to reset password if user forgot the old password.
ForgotPasswordResult	forgotPassword(java.lang.String username, java.util.Map<java.lang.String,java.lang.String> clientMetadata) Used to reset password if user forgot the old password.
void	forgotPassword(java.lang.String username, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<ForgotPasswordResult> callback) Used to reset password if user forgot the old password.
AWSCredentials	getAWSCredentials() Returns AWSCredentials obtained from Cognito Identity
void	getAWSCredentials(Callback<AWSCredentials> callback)
AWSConfigurable	getClient(android.content.Context context, java.lang.Class<? extends AWSConfigurable> clientClass) Get the AWSConfigurable client if exists, else create one and add it to the clientMap and return.
AWSConfiguration	getConfiguration() Retrieve the AWSConfiguration object that represents the awsconfiguration.json file.
AWSCredentials	getCredentials() Returns AWSCredentials which the caller can use to authorize an AWS request.
DeviceOperations	getDeviceOperations() Retrieve a handle to perform device related operations.
java.lang.String	getIdentityId()
static AWSMobileClient	getInstance() Gets the singleton instance of this class.
Tokens	getTokens() Returns the tokens obtained from Cognito Userpools sign-in.
void	getTokens(Callback<Tokens> callback) Returns the tokens obtained from Cognito Userpools sign-in.
java.util.Map<java.lang.String,java.lang.String>	getUserAttributes()
void	getUserAttributes(Callback<java.util.Map<java.lang.String,java.lang.String>> callback)
java.lang.String	getUsername() Returns the username attribute of the current access token.
boolean	handleAuthResponse(android.content.Intent intent) Pass in the Intent from the OAuth 2.0 exchange from showSignIn(Activity)
void	initialize(android.content.Context context, AWSConfiguration awsConfig, Callback<UserStateDetails> callback)
void	initialize(android.content.Context context, Callback<UserStateDetails> callback)
boolean	isSignedIn() A variant of currentUserState() that simplifies the output to a boolean.
void	refresh() Forces this credentials provider to refresh its credentials.
void	releaseSignInWait() Release the wait for tokens to be refreshed Doing this fails all pending operations that were waiting for sign-in.
boolean	removeUserStateListener(UserStateListener listener) Removes a listener.
SignUpResult	resendSignUp(java.lang.String username) Used when a user has attempted sign-up previously and wants to continue the process.
void	resendSignUp(java.lang.String username, Callback<SignUpResult> callback) Used when a user has attempted sign-up previously and wants to continue the process.
SignUpResult	resendSignUp(java.lang.String username, java.util.Map<java.lang.String,java.lang.String> clientMetadata) Used when a user has attempted sign-up previously and wants to continue the process.
void	resendSignUp(java.lang.String username, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<SignUpResult> callback) Used when a user has attempted sign-up previously and wants to continue the process.
UserStateDetails	showSignIn(android.app.Activity callingActivity) Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account
void	showSignIn(android.app.Activity callingActivity, Callback<UserStateDetails> callback) Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account
UserStateDetails	showSignIn(android.app.Activity callingActivity, SignInUIOptions signInUIOptions) Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account
void	showSignIn(android.app.Activity callingActivity, SignInUIOptions signInUIOptions, Callback<UserStateDetails> callback) Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account
SignInResult	signIn(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> validationData)
void	signIn(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> validationData, Callback<SignInResult> callback)
SignInResult	signIn(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> validationData, java.util.Map<java.lang.String,java.lang.String> clientMetadata)
void	signIn(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> validationData, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<SignInResult> callback)
void	signOut() Clears local tokens so that the client is in a signed-out state.
void	signOut(SignOutOptions signOutOptions) Sign-out the user with more options.
void	signOut(SignOutOptions signOutOptions, Callback<java.lang.Void> callback) Sign-out the user with more options.
SignUpResult	signUp(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> userAttributes, java.util.Map<java.lang.String,java.lang.String> validationData) Sign-up users.
void	signUp(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> userAttributes, java.util.Map<java.lang.String,java.lang.String> validationData, Callback<SignUpResult> callback) Sign-up users.
SignUpResult	signUp(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> userAttributes, java.util.Map<java.lang.String,java.lang.String> clientMetadata, java.util.Map<java.lang.String,java.lang.String> validationData) Sign-up users.
void	signUp(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> userAttributes, java.util.Map<java.lang.String,java.lang.String> validationData, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<SignUpResult> callback) Sign-up users.
java.util.List<UserCodeDeliveryDetails>	updateUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes) Sends a map of user attributes to update.
void	updateUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes, Callback<java.util.List<UserCodeDeliveryDetails>> callback) Sends a map of user attributes to update.
java.util.List<UserCodeDeliveryDetails>	updateUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes, java.util.Map<java.lang.String,java.lang.String> clientMetadata) Sends a map of user attributes to update.
void	updateUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<java.util.List<UserCodeDeliveryDetails>> callback) Sends a map of user attributes to update.
UserCodeDeliveryDetails	verifyUserAttribute(java.lang.String attributeName) Verify an attribute like email.
void	verifyUserAttribute(java.lang.String attributeName, Callback<UserCodeDeliveryDetails> callback) Verify an attribute like email.
UserCodeDeliveryDetails	verifyUserAttribute(java.lang.String attributeName, java.util.Map<java.lang.String,java.lang.String> clientMetadata) Verify an attribute like email.
void	verifyUserAttribute(java.lang.String attributeName, java.util.Map<java.lang.String,java.lang.String> clientMetadata, Callback<UserCodeDeliveryDetails> callback) Verify an attribute like email.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USER_AGENT

public static final java.lang.String DEFAULT_USER_AGENT

See Also:

Constant Field Values

HOSTED_UI_KEY

public static final java.lang.String HOSTED_UI_KEY

See Also:

Constant Field Values

CHALLENGE_RESPONSE_NEW_PASSWORD_KEY

public static final java.lang.String CHALLENGE_RESPONSE_NEW_PASSWORD_KEY

See Also:

Constant Field Values

CHALLENGE_RESPONSE_USER_ATTRIBUTES_PREFIX_KEY

public static final java.lang.String CHALLENGE_RESPONSE_USER_ATTRIBUTES_PREFIX_KEY

See Also:

Constant Field Values

Method Detail

getInstance

public static AWSMobileClient getInstance()

Gets the singleton instance of this class.

Returns:

singleton instance

getConfiguration

public AWSConfiguration getConfiguration()

Retrieve the AWSConfiguration object that represents the awsconfiguration.json file.

Returns:

the AWSConfiguration object

getCredentials

public AWSCredentials getCredentials()

Description copied from interface: AWSCredentialsProvider

Returns AWSCredentials which the caller can use to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.

Specified by:

getCredentials in interface AWSCredentialsProvider

Returns:

AWSCredentials which the caller can use to authorize an AWS request.

refresh

public void refresh()

Description copied from interface: AWSCredentialsProvider

Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.

Specified by:

refresh in interface AWSCredentialsProvider

getAWSCredentials

public AWSCredentials getAWSCredentials()
                                 throws java.lang.Exception

Returns AWSCredentials obtained from Cognito Identity

Returns:

AWSCredentials obtained from Cognito Identity

Throws:

java.lang.Exception

getAWSCredentials

public void getAWSCredentials(Callback<AWSCredentials> callback)

getIdentityId

public java.lang.String getIdentityId()

initialize

public void initialize(android.content.Context context,
                       Callback<UserStateDetails> callback)

initialize

public void initialize(android.content.Context context,
                       AWSConfiguration awsConfig,
                       Callback<UserStateDetails> callback)

getDeviceOperations

public DeviceOperations getDeviceOperations()

Retrieve a handle to perform device related operations. This is only available for Cognito User Pools and it must be configured in the client.

Returns:

a handle for device operations

releaseSignInWait

public void releaseSignInWait()

Release the wait for tokens to be refreshed Doing this fails all pending operations that were waiting for sign-in.

getUsername

public java.lang.String getUsername()

Returns the username attribute of the current access token. Note that the value stored in the username attribute of the access token may vary depending on how sign-in was performed. For example, if the user signed in with email, the username attribute will have the email address.

Returns:

The username attribute of the current access token.

See Also:

Using the Access Token from Cognito documentation.

currentUserState

public UserStateDetails currentUserState()

Performs a check on the current UserState. When online, this method will attempt to refresh tokens when they expired. Failing a refresh may cause the UserState to change.

Returns:

details about the user's state

currentUserState

public void currentUserState(Callback<UserStateDetails> callback)

Performs a check on the current UserState. When online, this method will attempt to refresh tokens when they expired. Failing a refresh may cause the UserState to change.

addUserStateListener

public void addUserStateListener(UserStateListener listener)

Adds a listener to be notified of state changes. When encountering SIGNED_OUT_FEDERATED_TOKENS_INVALID or SIGNED_OUT_USER_POOLS_TOKENS_INVALID releaseSignInWait() or any form of sign-in can be called to prevent blocking getCredentials(), getTokens(), or other methods requiring a sign-in.

Parameters:

listener -

removeUserStateListener

public boolean removeUserStateListener(UserStateListener listener)

Removes a listener. This will hold onto references. Remove when a lifecycle ends to prevent memory leaks.

Parameters:

listener -

Returns:

true if removed

isSignedIn

public boolean isSignedIn()

A variant of currentUserState() that simplifies the output to a boolean. True if SIGNED_IN, SIGNED_OUT_USER_POOLS_TOKENS_INVALID, SIGNED_OUT_FEDERATED_TOKENS_INVALID. False if GUEST, SIGNED_OUT.

Returns:

see above

signIn

public void signIn(java.lang.String username,
                   java.lang.String password,
                   java.util.Map<java.lang.String,java.lang.String> validationData,
                   Callback<SignInResult> callback)

signIn

public void signIn(java.lang.String username,
                   java.lang.String password,
                   java.util.Map<java.lang.String,java.lang.String> validationData,
                   java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                   Callback<SignInResult> callback)

signIn

public SignInResult signIn(java.lang.String username,
                           java.lang.String password,
                           java.util.Map<java.lang.String,java.lang.String> validationData)
                    throws java.lang.Exception

Throws:

java.lang.Exception

signIn

public SignInResult signIn(java.lang.String username,
                           java.lang.String password,
                           java.util.Map<java.lang.String,java.lang.String> validationData,
                           java.util.Map<java.lang.String,java.lang.String> clientMetadata)
                    throws java.lang.Exception

Throws:

java.lang.Exception

confirmSignIn

public void confirmSignIn(java.lang.String signInChallengeResponse,
                          Callback<SignInResult> callback)

confirmSignIn

public void confirmSignIn(java.lang.String signInChallengeResponse,
                          java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                          Callback<SignInResult> callback)

confirmSignIn

public SignInResult confirmSignIn(java.lang.String signInChallengeResponse)
                           throws java.lang.Exception

Throws:

java.lang.Exception

confirmSignIn

public SignInResult confirmSignIn(java.lang.String signInChallengeResponse,
                                  java.util.Map<java.lang.String,java.lang.String> clientMetadata)
                           throws java.lang.Exception

Throws:

java.lang.Exception

confirmSignIn

public void confirmSignIn(java.util.Map<java.lang.String,java.lang.String> signInChallengeResponse,
                          java.util.Map<java.lang.String,java.lang.String> clientMetaData,
                          Callback<SignInResult> callback)

The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>). Call with the user's response to the sign-in challenge.

Parameters:

signInChallengeResponse - obtained from user

clientMetaData - Meta data for lambda triggers

callback - callback

confirmSignIn

public SignInResult confirmSignIn(java.util.Map<java.lang.String,java.lang.String> signInChallengeResponse,
                                  java.util.Map<java.lang.String,java.lang.String> clientMetaData)
                           throws java.lang.Exception

The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>). Call with the user's response to the sign-in challenge.

Parameters:

signInChallengeResponse - obtained from user

clientMetaData - Meta data for lambda triggers

Returns:

the result containing next steps or done.

Throws:

java.lang.Exception

confirmSignIn

public void confirmSignIn(java.util.Map<java.lang.String,java.lang.String> signInChallengeResponse,
                          Callback<SignInResult> callback)

The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>). Call with the user's response to the sign-in challenge.

Parameters:

signInChallengeResponse - obtained from user

callback - callback

confirmSignIn

public SignInResult confirmSignIn(java.util.Map<java.lang.String,java.lang.String> signInChallengeResponse)
                           throws java.lang.Exception

The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>). Call with the user's response to the sign-in challenge.

Parameters:

signInChallengeResponse - obtained from user

Returns:

the result containing next steps or done.

Throws:

java.lang.Exception

signOut

public void signOut()

Clears local tokens so that the client is in a signed-out state.

signOut

public void signOut(SignOutOptions signOutOptions)
             throws java.lang.Exception

Sign-out the user with more options.

 
 SignOutOptions.builder()
                  .signOutGlobally(true) // Sign-out user from all sessions across devices
                  .build();
 
 

Parameters:

signOutOptions - options

Throws:

java.lang.Exception

signOut

public void signOut(SignOutOptions signOutOptions,
                    Callback<java.lang.Void> callback)

Sign-out the user with more options.

 
 SignOutOptions.builder()
                  .signOutGlobally(true) // Sign-out user from all sessions across devices
                  .build();
 
 

Parameters:

signOutOptions - options

federatedSignIn

public void federatedSignIn(java.lang.String providerKey,
                            java.lang.String token,
                            Callback<UserStateDetails> callback)

Federate tokens from custom identity providers into Cognito Identity Pool by providing the logins key and token

The logins key can be specified with IdentityProvider#AMAZON#toString()

Parameters:

providerKey - Custom provider key i.e. Google sign-in's key is accounts.google.com

token - the JWT token vended by the third-party

federatedSignIn

public UserStateDetails federatedSignIn(java.lang.String providerKey,
                                        java.lang.String token)
                                 throws java.lang.Exception

Federate tokens from custom identity providers into Cognito Identity Pool by providing the logins key and token

The logins key can be specified with IdentityProvider.AMAZON

Parameters:

providerKey - Custom provider key i.e. Google sign-in's key is accounts.google.com

token - the JWT token vended by the third-party

Throws:

java.lang.Exception

federatedSignIn

public void federatedSignIn(java.lang.String providerKey,
                            java.lang.String token,
                            FederatedSignInOptions options,
                            Callback<UserStateDetails> callback)

Federate tokens from custom identity providers by providing the logins key and token

The logins key can be specified with IdentityProvider#AMAZON#toString()

Parameters:

providerKey - Custom provider key i.e. Google sign-in's key is accounts.google.com

token - the JWT token vended by the third-party

federatedSignIn

public UserStateDetails federatedSignIn(java.lang.String providerKey,
                                        java.lang.String token,
                                        FederatedSignInOptions options)
                                 throws java.lang.Exception

Federate tokens from custom identity providers by providing the logins key and token

The logins key can be specified with IdentityProvider.AMAZON

Parameters:

providerKey - Custom provider key i.e. Google sign-in's key is accounts.google.com

token - the JWT token vended by the third-party

Throws:

java.lang.Exception

getTokens

public Tokens getTokens()
                 throws java.lang.Exception

Returns the tokens obtained from Cognito Userpools sign-in. Federated sign-in tokens are not supported.

Returns:

tokens from Cognito Userpools

Throws:

java.lang.Exception - when the tokens cannot be retrieved successfully.

getTokens

public void getTokens(Callback<Tokens> callback)

Returns the tokens obtained from Cognito Userpools sign-in. Federated sign-in tokens are not supported.

Throws:

java.lang.Exception - when the tokens cannot be retrieved successfully.

signUp

public void signUp(java.lang.String username,
                   java.lang.String password,
                   java.util.Map<java.lang.String,java.lang.String> userAttributes,
                   java.util.Map<java.lang.String,java.lang.String> validationData,
                   java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                   Callback<SignUpResult> callback)

Sign-up users. The SignUpResult will contain next steps if necessary. Call confirmSignUp(String, String, Callback) with the necessary next step code obtained from user.

Parameters:

username - username/email address/handle

password - user's password

userAttributes - attributes associated with user

validationData - optional, set of data to validate the sign-up request

clientMetadata - meta data to be passed to the lambdas invoked by sign up operation.

callback - callback will be invoked to notify the success or failure of the SignUp operation

signUp

public SignUpResult signUp(java.lang.String username,
                           java.lang.String password,
                           java.util.Map<java.lang.String,java.lang.String> userAttributes,
                           java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                           java.util.Map<java.lang.String,java.lang.String> validationData)
                    throws java.lang.Exception

Sign-up users. The SignUpResult will contain next steps if necessary. Call confirmSignUp(String, String) with the necessary next step code obtained from user.

Parameters:

username - username/email address/handle

password - user's password

userAttributes - attributes associated with user

validationData - optional, set of data to validate the sign-up request

clientMetadata - meta data to be passed to the lambdas invoked by sign up operation.

Returns:

result of the operation, potentially with next steps

Throws:

java.lang.Exception - if there is any error generated by the client

signUp

public void signUp(java.lang.String username,
                   java.lang.String password,
                   java.util.Map<java.lang.String,java.lang.String> userAttributes,
                   java.util.Map<java.lang.String,java.lang.String> validationData,
                   Callback<SignUpResult> callback)

Sign-up users. The SignUpResult will contain next steps if necessary. Call confirmSignUp(String, String, Callback) with the necessary next step code obtained from user.

Parameters:

username - username/email address/handle

password - user's password

userAttributes - attributes associated with user

validationData - optional, set of data to validate the sign-up request

callback - callback will be invoked to notify the success or failure of the SignUp operation

signUp

public SignUpResult signUp(java.lang.String username,
                           java.lang.String password,
                           java.util.Map<java.lang.String,java.lang.String> userAttributes,
                           java.util.Map<java.lang.String,java.lang.String> validationData)
                    throws java.lang.Exception

Sign-up users. The SignUpResult will contain next steps if necessary. Call confirmSignUp(String, String) with the necessary next step code obtained from user.

Parameters:

username - username/email address/handle

password - user's password

userAttributes - attributes associated with user

validationData - optional, set of data to validate the sign-up request

Returns:

result of the operation, potentially with next steps

Throws:

java.lang.Exception - if there is any error generated by the client

confirmSignUp

public void confirmSignUp(java.lang.String username,
                          java.lang.String signUpChallengeResponse,
                          java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                          Callback<SignUpResult> callback)

Confirm the sign-up request with follow-up information

Parameters:

username - username/email address/handle of the user who is signing up

signUpChallengeResponse - response to the signUp challenge posted

clientMetadata - meta data to be passed to the lambdas invoked by confirm sign up operation.

callback - the callback will be invoked to notify the success or failure of the confirmSignUp operation

confirmSignUp

public SignUpResult confirmSignUp(java.lang.String username,
                                  java.lang.String signUpChallengeResponse,
                                  java.util.Map<java.lang.String,java.lang.String> clientMetadata)
                           throws java.lang.Exception

Confirm the sign-up request with follow-up information

Parameters:

username - username of the user who is signing up

signUpChallengeResponse - response to the signUp challenge posted

clientMetadata - meta data to be passed to the lambdas invoked by confirm sign up operation.

Throws:

java.lang.Exception

confirmSignUp

public void confirmSignUp(java.lang.String username,
                          java.lang.String signUpChallengeResponse,
                          Callback<SignUpResult> callback)

Confirm the sign-up request with follow-up information

Parameters:

username - username/email address/handle of the user who is signing up

signUpChallengeResponse - response to the signUp challenge posted

callback - the callback will be invoked to notify the success or failure of the confirmSignUp operation

confirmSignUp

public SignUpResult confirmSignUp(java.lang.String username,
                                  java.lang.String signUpChallengeResponse)
                           throws java.lang.Exception

Confirm the sign-up request with follow-up information

Parameters:

username - username of the user who is signing up

signUpChallengeResponse - response to the signUp challenge posted

Throws:

java.lang.Exception

resendSignUp

public void resendSignUp(java.lang.String username,
                         Callback<SignUpResult> callback)

Used when a user has attempted sign-up previously and wants to continue the process. Note: If the user tries through the normal process with the same username, then it will fail and this method is required.

Parameters:

username -

callback -

resendSignUp

public void resendSignUp(java.lang.String username,
                         java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                         Callback<SignUpResult> callback)

Used when a user has attempted sign-up previously and wants to continue the process. Note: If the user tries through the normal process with the same username, then it will fail and this method is required.

Parameters:

clientMetadata - A map of custom key-value pairs that is passed to the lambda function for custom workflow.

username -

callback -

resendSignUp

public SignUpResult resendSignUp(java.lang.String username)
                          throws java.lang.Exception

Used when a user has attempted sign-up previously and wants to continue the process. Note: If the user tries through the normal process with the same username, then it will fail and this method is required.

Parameters:

username -

Throws:

java.lang.Exception

resendSignUp

public SignUpResult resendSignUp(java.lang.String username,
                                 java.util.Map<java.lang.String,java.lang.String> clientMetadata)
                          throws java.lang.Exception

Used when a user has attempted sign-up previously and wants to continue the process. Note: If the user tries through the normal process with the same username, then it will fail and this method is required.

Parameters:

clientMetadata - A map of custom key-value pairs that is passed to the lambda function for custom workflow.

username -

Throws:

java.lang.Exception

forgotPassword

public void forgotPassword(java.lang.String username,
                           java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                           Callback<ForgotPasswordResult> callback)

Used to reset password if user forgot the old password.

Parameters:

username - username of the user trying to reset password.

clientMetadata - meta data to be passed to the lambdas invoked by confirm sign up operation.

callback - callback will be invoked to notify the success or failure of the forgot password operation

forgotPassword

public ForgotPasswordResult forgotPassword(java.lang.String username,
                                           java.util.Map<java.lang.String,java.lang.String> clientMetadata)
                                    throws java.lang.Exception

Used to reset password if user forgot the old password.

Parameters:

username - username of the user trying to reset password.

Throws:

java.lang.Exception

forgotPassword

public void forgotPassword(java.lang.String username,
                           Callback<ForgotPasswordResult> callback)

Used to reset password if user forgot the old password.

Parameters:

username - username of the user trying to reset password.

callback - callback will be invoked to notify the success or failure of the forgot password operation

forgotPassword

public ForgotPasswordResult forgotPassword(java.lang.String username)
                                    throws java.lang.Exception

Used to reset password if user forgot the old password.

Parameters:

username - username of the user trying to reset password.

Throws:

java.lang.Exception

confirmForgotPassword

public void confirmForgotPassword(java.lang.String password,
                                  java.lang.String forgotPasswordChallengeResponse,
                                  java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                                  Callback<ForgotPasswordResult> callback)

Second method to call after forgotPassword(String) to respond to any challenges that the service may request.

Parameters:

password - new password

forgotPasswordChallengeResponse - response to the forgot password challenge posted

clientMetadata - metadata to be passed to the lambda invoked by this operation.

callback - callback will be invoked to notify the success or failure of the confirm forgot password operation

confirmForgotPassword

public ForgotPasswordResult confirmForgotPassword(java.lang.String password,
                                                  java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                                                  java.lang.String forgotPasswordChallengeResponse)
                                           throws java.lang.Exception

Second method to call after forgotPassword(String) to respond to any challenges that the service may request.

Parameters:

password - new password.

clientMetadata - metadata to be passed to the lambda invoked by this operation.

forgotPasswordChallengeResponse - response to the forgot password challenge posted.

Throws:

java.lang.Exception

confirmForgotPassword

public void confirmForgotPassword(java.lang.String password,
                                  java.lang.String forgotPasswordChallengeResponse,
                                  Callback<ForgotPasswordResult> callback)

Second method to call after forgotPassword(String) to respond to any challenges that the service may request.

Parameters:

password - new password.

forgotPasswordChallengeResponse - response to the forgot password challenge posted.

callback - callback will be invoked to notify the success or failure of the confirm forgot password operation

confirmForgotPassword

public ForgotPasswordResult confirmForgotPassword(java.lang.String password,
                                                  java.lang.String forgotPasswordChallengeResponse)
                                           throws java.lang.Exception

Second method to call after forgotPassword(String) to respond to any challenges that the service may request.

Parameters:

password - new password.

forgotPasswordChallengeResponse - response to the forgot password challenge posted.

Throws:

java.lang.Exception

changePassword

public void changePassword(java.lang.String oldPassword,
                           java.lang.String newPassword,
                           Callback<java.lang.Void> callback)

changePassword

public void changePassword(java.lang.String oldPassword,
                           java.lang.String newPassword)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getUserAttributes

public void getUserAttributes(Callback<java.util.Map<java.lang.String,java.lang.String>> callback)

getUserAttributes

public java.util.Map<java.lang.String,java.lang.String> getUserAttributes()
                                                                   throws java.lang.Exception

Throws:

java.lang.Exception

updateUserAttributes

public void updateUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes,
                                 Callback<java.util.List<UserCodeDeliveryDetails>> callback)

Sends a map of user attributes to update. If an attribute needs to be verified, then the verification delivery information is returned.

Parameters:

userAttributes - the attributes i.e. email

callback - verification delivery information

updateUserAttributes

public void updateUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes,
                                 java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                                 Callback<java.util.List<UserCodeDeliveryDetails>> callback)

Sends a map of user attributes to update. If an attribute needs to be verified, then the verification delivery information is returned.

Parameters:

userAttributes - the attributes i.e. email

clientMetadata - A map of custom key-value pairs that is passed to the lambda function for custom workflow.

callback - verification delivery information

updateUserAttributes

public java.util.List<UserCodeDeliveryDetails> updateUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes)
                                                             throws java.lang.Exception

Sends a map of user attributes to update. If an attribute needs to be verified, then the verification delivery information is returned.

Parameters:

userAttributes - the attributes i.e. email

Returns:

verification delivery information

Throws:

java.lang.Exception

updateUserAttributes

public java.util.List<UserCodeDeliveryDetails> updateUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes,
                                                                    java.util.Map<java.lang.String,java.lang.String> clientMetadata)
                                                             throws java.lang.Exception

Sends a map of user attributes to update. If an attribute needs to be verified, then the verification delivery information is returned.

Parameters:

userAttributes - the attributes i.e. email

clientMetadata - A map of custom key-value pairs that is passed to the lambda function for custom workflow.

Returns:

verification delivery information

Throws:

java.lang.Exception

verifyUserAttribute

public void verifyUserAttribute(java.lang.String attributeName,
                                Callback<UserCodeDeliveryDetails> callback)

Verify an attribute like email.

Parameters:

attributeName - i.e. email

callback - verification delivery information

verifyUserAttribute

public void verifyUserAttribute(java.lang.String attributeName,
                                java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                                Callback<UserCodeDeliveryDetails> callback)

Verify an attribute like email.

Parameters:

attributeName - i.e. email

clientMetadata - A map of custom key-value pairs that is passed to the lambda function for lambda functions triggered by forgot password.

callback - verification delivery information

verifyUserAttribute

public UserCodeDeliveryDetails verifyUserAttribute(java.lang.String attributeName)
                                            throws java.lang.Exception

Verify an attribute like email.

Parameters:

attributeName - i.e. email

Returns:

verification delivery information

Throws:

java.lang.Exception

verifyUserAttribute

public UserCodeDeliveryDetails verifyUserAttribute(java.lang.String attributeName,
                                                   java.util.Map<java.lang.String,java.lang.String> clientMetadata)
                                            throws java.lang.Exception

Verify an attribute like email.

Parameters:

attributeName - i.e. email

clientMetadata - A map of custom key-value pairs that is passed to the lambda function for lambda functions triggered by forgot password.

Returns:

verification delivery information

Throws:

java.lang.Exception

confirmUpdateUserAttribute

public void confirmUpdateUserAttribute(java.lang.String attributeName,
                                       java.lang.String updateUserAttributeChallengeResponse,
                                       Callback<java.lang.Void> callback)

Confirm the attribute with the code provided by user.

Parameters:

attributeName - i.e. email

updateUserAttributeChallengeResponse - i.e. 123456

callback - callback

confirmUpdateUserAttribute

public void confirmUpdateUserAttribute(java.lang.String attributeName,
                                       java.lang.String updateUserAttributeChallengeResponse)
                                throws java.lang.Exception

Confirm the attribute with the code provided by user.

Parameters:

attributeName - i.e. email

updateUserAttributeChallengeResponse - i.e. 123456

Throws:

java.lang.Exception

confirmVerifyUserAttribute

public void confirmVerifyUserAttribute(java.lang.String attributeName,
                                       java.lang.String updateUserAttributeChallengeResponse,
                                       Callback<java.lang.Void> callback)

Confirm the attribute with the code provided by user.

Parameters:

attributeName - i.e. email

updateUserAttributeChallengeResponse - i.e. 123456

callback - callback

confirmVerifyUserAttribute

public void confirmVerifyUserAttribute(java.lang.String attributeName,
                                       java.lang.String updateUserAttributeChallengeResponse)
                                throws java.lang.Exception

Confirm the attribute with the code provided by user.

Parameters:

attributeName - i.e. email

updateUserAttributeChallengeResponse - i.e. 123456

Throws:

java.lang.Exception

handleAuthResponse

public boolean handleAuthResponse(android.content.Intent intent)

Pass in the Intent from the OAuth 2.0 exchange from showSignIn(Activity)

Parameters:

intent -

Returns:

true if the intent was accepted.

showSignIn

public void showSignIn(android.app.Activity callingActivity,
                       Callback<UserStateDetails> callback)

Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account

Parameters:

callingActivity - The activity that the sign-in screen will be shown on top of.

callback - callback with UserStateDetails at end of operation

showSignIn

public UserStateDetails showSignIn(android.app.Activity callingActivity)
                            throws java.lang.Exception

Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account

Parameters:

callingActivity - The activity that the sign-in screen will be shown on top of.

Throws:

java.lang.Exception

showSignIn

public void showSignIn(android.app.Activity callingActivity,
                       SignInUIOptions signInUIOptions,
                       Callback<UserStateDetails> callback)

Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account

Parameters:

callingActivity - The activity that the sign-in screen will be shown on top of.

signInUIOptions - Override any default configuration with your preferences.

callback - callback with UserStateDetails at end of operation

showSignIn

public UserStateDetails showSignIn(android.app.Activity callingActivity,
                                   SignInUIOptions signInUIOptions)
                            throws java.lang.Exception

Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account

Parameters:

callingActivity - The activity that the sign-in screen will be shown on top of.

signInUIOptions - Override any default configuration with your preferences.

Throws:

java.lang.Exception

getClient

public AWSConfigurable getClient(android.content.Context context,
                                 java.lang.Class<? extends AWSConfigurable> clientClass)

Get the AWSConfigurable client if exists, else create one and add it to the clientMap and return.

Parameters:

context - The activity context

clientClass - SDK Client Class that confirms to the AWSConfigurable interface.