com.amazonaws.services.cognitoidentityprovider.model

Class RespondToAuthChallengeResult

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeResult

All Implemented Interfaces:

Serializable

public class RespondToAuthChallengeResult
extends Object
implements Serializable

The response to respond to the authentication challenge.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RespondToAuthChallengeResult()

Method Summary

Modifier and Type	Method and Description
RespondToAuthChallengeResult	addChallengeParametersEntry(String key, String value) The challenge parameters.
RespondToAuthChallengeResult	clearChallengeParametersEntries() Removes all the entries added into ChallengeParameters.
boolean	equals(Object obj)
AuthenticationResultType	getAuthenticationResult() The result returned by the server in response to the request to respond to the authentication challenge.
String	getChallengeName() The challenge name.
Map<String,String>	getChallengeParameters() The challenge parameters.
String	getSession() The session which should be passed both ways in challenge-response calls to the service.
int	hashCode()
void	setAuthenticationResult(AuthenticationResultType authenticationResult) The result returned by the server in response to the request to respond to the authentication challenge.
void	setChallengeName(ChallengeNameType challengeName) The challenge name.
void	setChallengeName(String challengeName) The challenge name.
void	setChallengeParameters(Map<String,String> challengeParameters) The challenge parameters.
void	setSession(String session) The session which should be passed both ways in challenge-response calls to the service.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RespondToAuthChallengeResult	withAuthenticationResult(AuthenticationResultType authenticationResult) The result returned by the server in response to the request to respond to the authentication challenge.
RespondToAuthChallengeResult	withChallengeName(ChallengeNameType challengeName) The challenge name.
RespondToAuthChallengeResult	withChallengeName(String challengeName) The challenge name.
RespondToAuthChallengeResult	withChallengeParameters(Map<String,String> challengeParameters) The challenge parameters.
RespondToAuthChallengeResult	withSession(String session) The session which should be passed both ways in challenge-response calls to the service.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RespondToAuthChallengeResult

public RespondToAuthChallengeResult()

Method Detail

getChallengeName

public String getChallengeName()

The challenge name. For more information, see .

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Returns:

The challenge name. For more information, see .

See Also:

ChallengeNameType

setChallengeName

public void setChallengeName(String challengeName)

The challenge name. For more information, see .

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Parameters:

challengeName -

The challenge name. For more information, see .

See Also:

ChallengeNameType

withChallengeName

public RespondToAuthChallengeResult withChallengeName(String challengeName)

The challenge name. For more information, see .

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Parameters:

challengeName -

The challenge name. For more information, see .

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ChallengeNameType

setChallengeName

public void setChallengeName(ChallengeNameType challengeName)

The challenge name. For more information, see .

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Parameters:

challengeName -

The challenge name. For more information, see .

See Also:

ChallengeNameType

withChallengeName

public RespondToAuthChallengeResult withChallengeName(ChallengeNameType challengeName)

The challenge name. For more information, see .

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

Parameters:

challengeName -

The challenge name. For more information, see .

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ChallengeNameType

getSession

public String getSession()

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Constraints:
Length: 20 - 2048

Returns:

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

setSession

public void setSession(String session)

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Constraints:
Length: 20 - 2048

Parameters:

session -

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

withSession

public RespondToAuthChallengeResult withSession(String session)

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048

Parameters:

session -

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Returns:

A reference to this updated object so that method calls can be chained together.

getChallengeParameters

public Map<String,String> getChallengeParameters()

The challenge parameters. For more information, see .

Returns:

The challenge parameters. For more information, see .

setChallengeParameters

public void setChallengeParameters(Map<String,String> challengeParameters)

The challenge parameters. For more information, see .

Parameters:

challengeParameters -

The challenge parameters. For more information, see .

withChallengeParameters

public RespondToAuthChallengeResult withChallengeParameters(Map<String,String> challengeParameters)

The challenge parameters. For more information, see .

Returns a reference to this object so that method calls can be chained together.

Parameters:

challengeParameters -

The challenge parameters. For more information, see .

Returns:

A reference to this updated object so that method calls can be chained together.

addChallengeParametersEntry

public RespondToAuthChallengeResult addChallengeParametersEntry(String key,
                                                                String value)

The challenge parameters. For more information, see .

The method adds a new key-value pair into ChallengeParameters parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into ChallengeParameters.

value - The corresponding value of the entry to be added into ChallengeParameters.

Returns:

A reference to this updated object so that method calls can be chained together.

clearChallengeParametersEntries

public RespondToAuthChallengeResult clearChallengeParametersEntries()

Removes all the entries added into ChallengeParameters.

Returns a reference to this object so that method calls can be chained together.

getAuthenticationResult

public AuthenticationResultType getAuthenticationResult()

The result returned by the server in response to the request to respond to the authentication challenge.

Returns:

The result returned by the server in response to the request to respond to the authentication challenge.

setAuthenticationResult

public void setAuthenticationResult(AuthenticationResultType authenticationResult)

The result returned by the server in response to the request to respond to the authentication challenge.

Parameters:

authenticationResult -

The result returned by the server in response to the request to respond to the authentication challenge.

withAuthenticationResult

public RespondToAuthChallengeResult withAuthenticationResult(AuthenticationResultType authenticationResult)

The result returned by the server in response to the request to respond to the authentication challenge.

Returns a reference to this object so that method calls can be chained together.

Parameters:

authenticationResult -

The result returned by the server in response to the request to respond to the authentication challenge.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object