com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations

Class AuthenticationDetails

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.AuthenticationDetails

public class AuthenticationDetails
extends java.lang.Object

Encapsulates all data required to authenticate a user. Pass an object of this type to the continuation object to continue with the authentication process. This contents of this object are set when it is constructed and are immutable afterwards.

Constructor Summary

Constructors

Constructor and Description
AuthenticationDetails(java.lang.String userId, java.util.Map<java.lang.String,java.lang.String> authenticationParameters, java.util.Map<java.lang.String,java.lang.String> validationData) Constructs a new object for custom authentication.
AuthenticationDetails(java.lang.String userId, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> validationData) Constructs a new object with authentication details.
AuthenticationDetails(java.lang.String userId, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> authenticationParameters, java.util.Map<java.lang.String,java.lang.String> validationData) Constructs a new object for custom authentication that starts with SRP protocol.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAuthenticationParameters() The authentication parameters set for custom authentication process.
java.lang.String	getAuthenticationType() This method returns the authentication type.
java.lang.String	getCustomChallenge()
java.lang.String	getPassword() This method returns the password.
java.lang.String	getUserId() This method returns the User Id.
java.util.List<AttributeType>	getValidationData() This method returns the validation data.
void	setAuthenticationParameter(java.lang.String key, java.lang.String value) Set an authentication detail, will override the current value.
void	setAuthenticationParameters(java.util.Map<java.lang.String,java.lang.String> authenticationParameters) Sets new authentication details, will override the current values.
void	setAuthenticationType(java.lang.String authenticationType) Set the type of authentication to be used in this instance.
void	setCustomChallenge(java.lang.String customChallenge) Set the name of the custom challenge.
void	setPassword(java.lang.String password)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationDetails

public AuthenticationDetails(java.lang.String userId,
                             java.lang.String password,
                             java.util.Map<java.lang.String,java.lang.String> validationData)

Constructs a new object with authentication details.

Parameters:

userId - REQUIRED: User ID, NOTE: This will over ride the current Used ID.

password - REQUIRED: Users' password.

validationData - REQUIRED: Validation data parameters for the pre-auth lambda.

AuthenticationDetails

public AuthenticationDetails(java.lang.String userId,
                             java.lang.String password,
                             java.util.Map<java.lang.String,java.lang.String> authenticationParameters,
                             java.util.Map<java.lang.String,java.lang.String> validationData)

Constructs a new object for custom authentication that starts with SRP protocol. The first to challenges to be answered are SRP_A and PASSWORD_VERIFIER.

Parameters:

userId - REQUIRED: User ID, NOTE: This will over ride the current user ID

password - REQUIRED: This will be used to answer the PASSWORD_VERIFIER challenge.

authenticationParameters - REQUIRED: Authentication details that are used in custom authentication process

validationData - REQUIRED: Contains authentication parameters which are passed to triggered pre-auth lambda trigger.

AuthenticationDetails

public AuthenticationDetails(java.lang.String userId,
                             java.util.Map<java.lang.String,java.lang.String> authenticationParameters,
                             java.util.Map<java.lang.String,java.lang.String> validationData)

Constructs a new object for custom authentication.

Parameters:

userId - REQUIRED: User ID, NOTE: This will over ride the current Used ID.

authenticationParameters - REQUIRED: Authentication details to launch custom authentication process.

validationData - REQUIRED: Contains authentication parameters which are passed to triggered pre-auth lambda. trigger

Method Detail

setAuthenticationType

public void setAuthenticationType(java.lang.String authenticationType)

Set the type of authentication to be used in this instance.

Parameters:

authenticationType - REQUIRED: The authentication type indicator.

setPassword

public void setPassword(java.lang.String password)

getPassword

public java.lang.String getPassword()

This method returns the password.

Returns:

password set.

getUserId

public java.lang.String getUserId()

This method returns the User Id.

Returns:

userId set in this object.

getValidationData

public java.util.List<AttributeType> getValidationData()

This method returns the validation data.

Returns:

validation data set in this object.

getAuthenticationType

public java.lang.String getAuthenticationType()

This method returns the authentication type.

Returns:

the authentication type set for this object.

getAuthenticationParameters

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

The authentication parameters set for custom authentication process.

Returns:

Authentication details as a Map.

setCustomChallenge

public void setCustomChallenge(java.lang.String customChallenge)

Set the name of the custom challenge. This will override the existing authentication name.

Parameters:

customChallenge - REQUIRED: Custom challenge name.

getCustomChallenge

public java.lang.String getCustomChallenge()

setAuthenticationParameters

public void setAuthenticationParameters(java.util.Map<java.lang.String,java.lang.String> authenticationParameters)

Sets new authentication details, will override the current values.

Parameters:

authenticationParameters - REQUIRED: Authentication details as a Map.

setAuthenticationParameter

public void setAuthenticationParameter(java.lang.String key,
                                       java.lang.String value)

Set an authentication detail, will override the current value.

Parameters:

key - REQUIRED: Authentication detail key.

value - REQUIRED: Authentication detail value.