com.amazonaws.auth

Class AWSEnhancedCognitoIdentityProvider

java.lang.Object

com.amazonaws.auth.AWSAbstractCognitoIdentityProvider

com.amazonaws.auth.AWSEnhancedCognitoIdentityProvider

All Implemented Interfaces:

AWSCognitoIdentityProvider, AWSIdentityProvider

public final class AWSEnhancedCognitoIdentityProvider
extends AWSAbstractCognitoIdentityProvider

An extension of the AbstractCognitoProvider that is used to communicate with Cognito when using the enhanced authentication flow. All other functionality is the same as that of AbstractCognitoIdentityProvider.

Field Summary

Fields inherited from class com.amazonaws.auth.AWSAbstractCognitoIdentityProvider

cib, identityId, listeners, loginsMap, token

Constructor Summary

Constructors

Constructor and Description
AWSEnhancedCognitoIdentityProvider(String accountId, String identityPoolId) An extension of the AbstractCognitoProvider that is used to communicate with Cognito.
AWSEnhancedCognitoIdentityProvider(String accountId, String identityPoolId, AmazonCognitoIdentity cibClient) An extension of the AbstractCognitoProvider that is used to communicate with Cognito.
AWSEnhancedCognitoIdentityProvider(String accountId, String identityPoolId, ClientConfiguration clientConfiguration) An extension of the AbstractCognitoProvider that is used to communicate with Cognito.

Method Summary

Methods

Modifier and Type	Method and Description
String	getProviderName() Gets a string with the name of the provider being used.
String	refresh() To be used to call the provider back end to get a token and identityId.

Methods inherited from class com.amazonaws.auth.AWSAbstractCognitoIdentityProvider

appendUserAgent, clearListeners, getAccountId, getIdentityId, getIdentityPoolId, getLogins, getToken, getUserAgent, identityChanged, isAuthenticated, registerIdentityChangedListener, setIdentityId, setLogins, setToken, unregisterIdentityChangedListener, update

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSEnhancedCognitoIdentityProvider

public AWSEnhancedCognitoIdentityProvider(String accountId,
                                  String identityPoolId)

An extension of the AbstractCognitoProvider that is used to communicate with Cognito.

Parameters:

accountId - the account id of the developer

identityPoolId - the identity pool id of the app/user in question

AWSEnhancedCognitoIdentityProvider

public AWSEnhancedCognitoIdentityProvider(String accountId,
                                  String identityPoolId,
                                  ClientConfiguration clientConfiguration)

An extension of the AbstractCognitoProvider that is used to communicate with Cognito.

Parameters:

accountId - the account id of the developer

identityPoolId - the identity pool id of the app/user in question

clientConfiguration - the configuration to apply to service clients created

AWSEnhancedCognitoIdentityProvider

public AWSEnhancedCognitoIdentityProvider(String accountId,
                                  String identityPoolId,
                                  AmazonCognitoIdentity cibClient)

An extension of the AbstractCognitoProvider that is used to communicate with Cognito.

Parameters:

accountId - the account id of the developer

identityPoolId - the identity pool id of the app/user in question

cibClient - the cib client which will be used to contact the cib back end

Method Detail

getProviderName

public String getProviderName()

Description copied from class: AWSAbstractCognitoIdentityProvider

Gets a string with the name of the provider being used. For example, Cognito would return "Cognito";

Specified by:

getProviderName in class AWSAbstractCognitoIdentityProvider

Returns:

the name of the provider in a string

refresh

public String refresh()

Description copied from interface: AWSIdentityProvider

To be used to call the provider back end to get a token and identityId. Once that has returned, a call to the superclass' update(String, Token) method should be called

Specified by:

refresh in interface AWSIdentityProvider

Overrides:

refresh in class AWSAbstractCognitoIdentityProvider

Returns:

token returns the token that was updated in the refresh