com.amazonaws.mobileconnectors.cognitoidentityprovider.handlers

Interface AuthenticationHandler

public interface AuthenticationHandler

Callback handler for user authentication process.

Method Summary

Modifier and Type	Method and Description
void	authenticationChallenge(ChallengeContinuation continuation) Call out to the dev to respond to a challenge.
void	getAuthenticationDetails(AuthenticationContinuation authenticationContinuation, java.lang.String userId) Call out to the dev to get the credentials for a user.
void	getMFACode(MultiFactorAuthenticationContinuation continuation) Call out to the dev to send MFA code.
void	onFailure(java.lang.Exception exception) This method is called when a fatal exception was encountered during authentication.
void	onSuccess(CognitoUserSession userSession, CognitoDevice newDevice) This method is called to deliver valid tokens, when valid tokens were locally available (cached) or after successful completion of the authentication process.

Method Detail

onSuccess

void onSuccess(CognitoUserSession userSession,
               CognitoDevice newDevice)

This method is called to deliver valid tokens, when valid tokens were locally available (cached) or after successful completion of the authentication process. The newDevice will is an instance of CognitoDevice for this device, and this parameter will be not null during these cases: 1- If the user pool allows devices to be remembered and this is is a new device, that is first time authentication on this device. 2- When the cached device key is lost and, hence, the service identifies this as a new device.

Parameters:

userSession - Contains valid user tokens.

newDevice - CognitoDevice, will be null if this is not a new device.

getAuthenticationDetails

void getAuthenticationDetails(AuthenticationContinuation authenticationContinuation,
                              java.lang.String userId)

Call out to the dev to get the credentials for a user.

Parameters:

authenticationContinuation - is a AuthenticationContinuation object that should be used to continue with the authentication process when the users' authentication details are available.

userId - Is the user-ID (username or alias) used in authentication. This will be null if the user ID is not available.

getMFACode

void getMFACode(MultiFactorAuthenticationContinuation continuation)

Call out to the dev to send MFA code. MFA code would have been sent via the deliveryMethod before this is invoked. This callback can be invoked in two scenarios - 1) MFA verification is required and only one possible MFA delivery medium is available. 2) MFA verification is required and a MFA delivery medium was successfully set. 3) An MFA code sent earlier was incorrect and at-least one more attempt to send MFA code is available.

Parameters:

continuation - medium through which the MFA will be delivered

authenticationChallenge

void authenticationChallenge(ChallengeContinuation continuation)

Call out to the dev to respond to a challenge. The authentication process as presented the user with the a challenge, to successfully authenticate. This a generic challenge, that is not MFA or user password verification.

Parameters:

continuation - contains details about the challenge and allows dev to respond to the challenge.

onFailure

void onFailure(java.lang.Exception exception)

This method is called when a fatal exception was encountered during authentication. The current authentication process continue because of the error , hence a continuation is not available. Probe exception for details.

Parameters:

exception - is this Exception leading to authentication failure.