com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations

Class ChallengeContinuation

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.ChallengeContinuation

All Implemented Interfaces:

CognitoIdentityProviderContinuation<java.util.Map<java.lang.String,java.lang.String>>

Direct Known Subclasses:

ChooseMfaContinuation, NewPasswordContinuation, RegisterMfaContinuation

public class ChallengeContinuation
extends java.lang.Object
implements CognitoIdentityProviderContinuation<java.util.Map<java.lang.String,java.lang.String>>

Defines a Continuation for a generic auth-challenge. This Continuation is used for all developer driven challenges.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	RUN_IN_BACKGROUND Run in background.
static boolean	RUN_IN_CURRENT Run on current thread.

Constructor Summary

Constructors

Constructor and Description
ChallengeContinuation(CognitoUser user, android.content.Context context, java.lang.String username, java.lang.String clientId, java.lang.String secretHash, com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeResult challengeResult, boolean runInBackground, AuthenticationHandler callback) Constructs a continuation for a challenge to be presented to the user.

Method Summary

Modifier and Type	Method and Description
void	continueTask() Continues the authentication process by responding to the generic challenge posed by the system.
java.lang.String	getChallengeName() Returns the name of the challenge.
java.util.Map<java.lang.String,java.lang.String>	getClientMetaData() clientMetadata is a map of custom key-value pairs that you can provide as input for any custom work flows.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Returns the challenges parameters for a generic challenge (developer defined) challenge.
void	setChallengeResponse(java.lang.String responseKey, java.lang.String responseValue) Add responses to the authentication challenge.
void	setClientMetaData(java.util.Map<java.lang.String,java.lang.String> clientMetaData) Mutator for clientMetadata.
void	setResponseSessionCode(java.lang.String session) Over-write the current challenge session code.

Methods inherited from class java.lang.Object

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

Field Detail

RUN_IN_BACKGROUND

public static final boolean RUN_IN_BACKGROUND

Run in background.

See Also:

Constant Field Values

RUN_IN_CURRENT

public static final boolean RUN_IN_CURRENT

Run on current thread.

See Also:

Constant Field Values

Constructor Detail

ChallengeContinuation

public ChallengeContinuation(CognitoUser user,
                             android.content.Context context,
                             java.lang.String username,
                             java.lang.String clientId,
                             java.lang.String secretHash,
                             com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeResult challengeResult,
                             boolean runInBackground,
                             AuthenticationHandler callback)

Constructs a continuation for a challenge to be presented to the user.

Parameters:

user - REQUIRED: Reference to the user being authenticated.

context - REQUIRED: Android application context.

username - REQUIRED: Username used for this auth attempt.

clientId - REQUIRED: Cognito App Id

secretHash - REQUIRED: Hash of the App Secret

challengeResult - REQUIRED: Response from Cognito containing information about the new challenge.

runInBackground - REQUIRED: Indicates if continuation must execute in a background thread.

callback - REQUIRED: Reference to the callback handler.

Method Detail

getClientMetaData

public java.util.Map<java.lang.String,java.lang.String> getClientMetaData()

clientMetadata is a map of custom key-value pairs that you can provide as input for any custom work flows. Accessor method for clientMetadata.

Returns:

ClientMetadata

setClientMetaData

public void setClientMetaData(java.util.Map<java.lang.String,java.lang.String> clientMetaData)

Mutator for clientMetadata.

Parameters:

clientMetaData - MetaData to be passed as input to the lambda triggers.

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Returns the challenges parameters for a generic challenge (developer defined) challenge. The keys in this map are usually determined by the developer. They should contain all the information and resources required by the app, to determine the type of challenge and to present the challenge to the user. This opens up the authentication process to the developers to bring their custom steps to authenticate to Cognito User Pools.

Specified by:

getParameters in interface CognitoIdentityProviderContinuation<java.util.Map<java.lang.String,java.lang.String>>

Returns:

A Map containing parameters for this auth challenge process.

getChallengeName

public java.lang.String getChallengeName()

Returns the name of the challenge. Use the challenge name and the challenge parameters to identity the challenge and correctly present to the user.

Returns:

the challenge name as a String.

setChallengeResponse

public void setChallengeResponse(java.lang.String responseKey,
                                 java.lang.String responseValue)

Add responses to the authentication challenge. The responses are added as key-value pairs. The keys are usually unique to the challenge and are often determined by the developers who have set this challenge. Note: Overrides an earlier value set for the attribute.

Parameters:

responseKey - REQUIRED: The key (identifier) for a parameter in the challenge response.

responseValue - REQUIRED: The value of the key (identifier),

continueTask

public void continueTask()

Continues the authentication process by responding to the generic challenge posed by the system. This invokes the method to respond to the generic authentication challenge in the current or on a background thread depending up on how the authentication process with initiated. This method gets a Runnable which is is always executed in the applications thread. The mechanism to identify the current thread and to run the returned Runnable in the apps thread is implemented in this method.

Specified by:

continueTask in interface CognitoIdentityProviderContinuation<java.util.Map<java.lang.String,java.lang.String>>

setResponseSessionCode

public void setResponseSessionCode(java.lang.String session)

Over-write the current challenge session code.

Parameters:

session - REQUIRED: The new session code.