com.amazonaws.mobileconnectors.cognitoidentityprovider

Class CognitoUserPool

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUserPool

public class CognitoUserPool
extends java.lang.Object

This represents a user-pool in a Cognito identity provider account. The user-pools are called as Cognito User Identity Pool or User Identity Pool or User Pool. All of these terms represent the same entity, which is a pool of users in your account.

A user-pool can have these: 1) User pool ID, userPoolId. This is an unique identifier for your user pool. This is a required parameter to use the SDK. 2) Client identifier, clientId. This is generated for a user pool and each user pool can have several of these. A client identifier will associated with one, and only one, user pool. This is required to use the SDK. A client identifier can have one or no client secrets. 3) Client secret, clientSecret. This is generated for a Client identified. A client identifier may have a client secret, it is not necessary to generate a client secret for all client identifiers. However if a client identifier has a client secret then this client secret has to be used, along with the client identifier, in the SDK.

On a user-pool new user's can sign-up and create new CognitoUser.

Constructor Summary

Constructors

Constructor and Description
CognitoUserPool(android.content.Context context, AWSConfiguration awsConfiguration) Constructs a user-pool with default ClientConfiguration.
CognitoUserPool(android.content.Context context, java.lang.String userPoolId, java.lang.String clientId, java.lang.String clientSecret) Deprecated. use CognitoUserPool(Context, String, String, String, ClientConfiguration, Regions) Constructs a user-pool with default ClientConfiguration and default AWS region Regions. Region defaults to US-EAST-1.
CognitoUserPool(android.content.Context context, java.lang.String userPoolId, java.lang.String clientId, java.lang.String clientSecret, com.amazonaws.services.cognitoidentityprovider.AmazonCognitoIdentityProvider client) Constructs a user-pool with default ClientConfiguration.
CognitoUserPool(android.content.Context context, java.lang.String userPoolId, java.lang.String clientId, java.lang.String clientSecret, com.amazonaws.services.cognitoidentityprovider.AmazonCognitoIdentityProvider client, java.lang.String pinpointAppId) Constructs a user-pool with default ClientConfiguration and integrated analytics.
CognitoUserPool(android.content.Context context, java.lang.String userPoolId, java.lang.String clientId, java.lang.String clientSecret, ClientConfiguration clientConfiguration) Deprecated. use CognitoUserPool(Context, String, String, String, ClientConfiguration, Regions) Constructs a user-pool with a developer specified ClientConfiguration and default AWS region Regions. Region defaults to US-EAST-1.
CognitoUserPool(android.content.Context context, java.lang.String userPoolId, java.lang.String clientId, java.lang.String clientSecret, ClientConfiguration clientConfiguration, Regions region) Constructs a user-pool.
CognitoUserPool(android.content.Context context, java.lang.String userPoolId, java.lang.String clientId, java.lang.String clientSecret, ClientConfiguration clientConfiguration, Regions region, java.lang.String pinpointAppId) Constructs a user-pool with integrated Pinpoint analytics.
CognitoUserPool(android.content.Context context, java.lang.String userPoolId, java.lang.String clientId, java.lang.String clientSecret, Regions region) Constructs a user-pool with default ClientConfiguration.
CognitoUserPool(android.content.Context context, java.lang.String userPoolId, java.lang.String clientId, java.lang.String clientSecret, Regions region, java.lang.String pinpointAppId) Constructs a user-pool with default ClientConfiguration.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientId() Returns Client ID set for this pool.
CognitoUser	getCurrentUser() Returns last authenticated user on this device in this user pool.
CognitoUser	getUser() Returns a CognitoUser with no username set.
CognitoUser	getUser(java.lang.String userId) Returns a CognitoUser with userId userId
java.lang.String	getUserPoolId() Returns Pool ID of this pool.
void	setAdvancedSecurityDataCollectionFlag(boolean isEnabled) This method sets context data collection for the user.
void	setPersistenceEnabled(boolean isPersistenceEnabled) Enable or disable persistence
void	signUp(java.lang.String userId, java.lang.String password, CognitoUserAttributes userAttributes, java.util.Map<java.lang.String,java.lang.String> validationData, java.util.Map<java.lang.String,java.lang.String> clientMetadata, SignUpHandler callback) Runs user registration in current thread.
void	signUp(java.lang.String userId, java.lang.String password, CognitoUserAttributes userAttributes, java.util.Map<java.lang.String,java.lang.String> validationData, SignUpHandler callback) Runs user registration in current thread.
void	signUpInBackground(java.lang.String userId, java.lang.String password, CognitoUserAttributes userAttributes, java.util.Map<java.lang.String,java.lang.String> validationData, java.util.Map<java.lang.String,java.lang.String> clientMetadata, SignUpHandler callback) Runs user registration in background.
void	signUpInBackground(java.lang.String userId, java.lang.String password, CognitoUserAttributes userAttributes, java.util.Map<java.lang.String,java.lang.String> validationData, SignUpHandler callback) Runs user registration in background.

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoUserPool

@Deprecated
public CognitoUserPool(android.content.Context context,
                                   java.lang.String userPoolId,
                                   java.lang.String clientId,
                                   java.lang.String clientSecret,
                                   ClientConfiguration clientConfiguration)

Deprecated. use CognitoUserPool(Context, String, String, String, ClientConfiguration, Regions)

Constructs a user-pool with a developer specified ClientConfiguration and default AWS region Regions. Region defaults to US-EAST-1.

Parameters:

context - REQUIRED: Android application context

userPoolId - REQUIRED: User-pool-Id of the user-pool

clientId - REQUIRED: Client-Id generated for this app and user-pool at the Cognito Identity Provider developer console

clientSecret - REQUIRED: Client Secret generated for this app and user-pool at the Cognito Identity Provider developer console

clientConfiguration - REQUIRED: The client configuration options controlling how this client connects to Cognito Identity Provider Service (e.g. proxy settings, retry counts, etc.).

CognitoUserPool

@Deprecated
public CognitoUserPool(android.content.Context context,
                                   java.lang.String userPoolId,
                                   java.lang.String clientId,
                                   java.lang.String clientSecret)

Deprecated. use CognitoUserPool(Context, String, String, String, ClientConfiguration, Regions)

Constructs a user-pool with default ClientConfiguration and default AWS region Regions. Region defaults to US-EAST-1.

Parameters:

context - REQUIRED: Android application context.

userPoolId - REQUIRED: User-pool-Id of the user-pool.

clientId - REQUIRED: Client-Id generated for this app and user-pool at the Cognito Identity Provider developer console.

clientSecret - REQUIRED: Client Secret generated for this app and user-pool at the Cognito Identity Provider developer console.

CognitoUserPool

public CognitoUserPool(android.content.Context context,
                       AWSConfiguration awsConfiguration)

Constructs a user-pool with default ClientConfiguration.

Parameters:

context - REQUIRED: Android application context.

awsConfiguration - REQUIRED: Holds the configuration read from awsconfiguration.json

CognitoUserPool

public CognitoUserPool(android.content.Context context,
                       java.lang.String userPoolId,
                       java.lang.String clientId,
                       java.lang.String clientSecret,
                       Regions region)

Constructs a user-pool with default ClientConfiguration.

Parameters:

context - REQUIRED: Android application context.

userPoolId - REQUIRED: User-pool-Id of the user-pool.

clientId - REQUIRED: Client-Id generated for this app and user-pool at the Cognito Identity Provider developer console.

clientSecret - REQUIRED: Client Secret generated for this app and user-pool at the Cognito Identity Provider developer console.

region - REQUIRED: AWS region Regions.

CognitoUserPool

public CognitoUserPool(android.content.Context context,
                       java.lang.String userPoolId,
                       java.lang.String clientId,
                       java.lang.String clientSecret,
                       Regions region,
                       java.lang.String pinpointAppId)

Constructs a user-pool with default ClientConfiguration.

Parameters:

context - REQUIRED: Android application context.

userPoolId - REQUIRED: User-pool-Id of the user-pool.

clientId - REQUIRED: Client-Id generated for this app and user-pool at the Cognito Identity Provider developer console.

clientSecret - REQUIRED: Client Secret generated for this app and user-pool at the Cognito Identity Provider developer console.

region - REQUIRED: AWS region Regions.

pinpointAppId - REQUIRED: AWS Pinpoint App Id for analytics.

CognitoUserPool

public CognitoUserPool(android.content.Context context,
                       java.lang.String userPoolId,
                       java.lang.String clientId,
                       java.lang.String clientSecret,
                       ClientConfiguration clientConfiguration,
                       Regions region)

Constructs a user-pool.

Parameters:

context - REQUIRED: Android application context.

userPoolId - REQUIRED: User-pool-Id of the user-pool.

clientId - REQUIRED: Client-Id generated for this app and user-pool at the Cognito Identity Provider developer console.

clientSecret - REQUIRED: Client Secret generated for this app and user-pool at the Cognito Identity Provider developer console.

clientConfiguration - REQUIRED: The client configuration options controlling how this client connects to Cognito Identity Provider Service (e.g. proxy settings, retry counts, etc.).

region - REQUIRED: AWS region Regions.

CognitoUserPool

public CognitoUserPool(android.content.Context context,
                       java.lang.String userPoolId,
                       java.lang.String clientId,
                       java.lang.String clientSecret,
                       ClientConfiguration clientConfiguration,
                       Regions region,
                       java.lang.String pinpointAppId)

Constructs a user-pool with integrated Pinpoint analytics.

Parameters:

context - REQUIRED: Android application context.

userPoolId - REQUIRED: User-pool-Id of the user-pool.

clientId - REQUIRED: Client-Id generated for this app and user-pool at the Cognito Identity Provider developer console.

clientSecret - REQUIRED: Client Secret generated for this app and user-pool at the Cognito Identity Provider developer console.

clientConfiguration - REQUIRED: The client configuration options controlling how this client connects to Cognito Identity Provider Service (e.g. proxy settings, retry counts, etc.).

region - REQUIRED: AWS region Regions.

pinpointAppId - REQUIRED: AWS Pinpoint App Id for analytics.

CognitoUserPool

public CognitoUserPool(android.content.Context context,
                       java.lang.String userPoolId,
                       java.lang.String clientId,
                       java.lang.String clientSecret,
                       com.amazonaws.services.cognitoidentityprovider.AmazonCognitoIdentityProvider client)

Constructs a user-pool with default ClientConfiguration.

Parameters:

context - REQUIRED: Android application context.

userPoolId - REQUIRED: User-pool-Id of the user-pool.

clientId - REQUIRED: Client-Id generated for this app and user-pool at the Cognito Identity Provider developer console.

clientSecret - REQUIRED: Client Secret generated for this app and user-pool at the Cognito Identity Provider developer console.

client - REQUIRED: AWS low-level Cognito Identity Provider Client.

CognitoUserPool

public CognitoUserPool(android.content.Context context,
                       java.lang.String userPoolId,
                       java.lang.String clientId,
                       java.lang.String clientSecret,
                       com.amazonaws.services.cognitoidentityprovider.AmazonCognitoIdentityProvider client,
                       java.lang.String pinpointAppId)

Constructs a user-pool with default ClientConfiguration and integrated analytics.

Parameters:

context - REQUIRED: Android application context.

userPoolId - REQUIRED: User-pool-Id of the user-pool.

clientId - REQUIRED: Client-Id generated for this app and user-pool at the Cognito Identity Provider developer console.

clientSecret - REQUIRED: Client Secret generated for this app and user-pool at the Cognito Identity Provider developer console.

client - REQUIRED: AWS low-level Cognito Identity Provider Client.

pinpointAppId - REQUIRED: AWS Pinpoint App Id for analytics.

Method Detail

getClientId

public java.lang.String getClientId()

Returns Client ID set for this pool.

Returns:

Client ID.

getUserPoolId

public java.lang.String getUserPoolId()

Returns Pool ID of this pool.

Returns:

Your User Pool ID.

setAdvancedSecurityDataCollectionFlag

public void setAdvancedSecurityDataCollectionFlag(boolean isEnabled)

This method sets context data collection for the user. This data is sent to the server for risk evaluation. By default data collection is enabled.

Parameters:

isEnabled - if the data collection is enabled.

setPersistenceEnabled

public void setPersistenceEnabled(boolean isPersistenceEnabled)

Enable or disable persistence

Parameters:

isPersistenceEnabled - flag if true indicates tokens are persisted.

signUpInBackground

public void signUpInBackground(java.lang.String userId,
                               java.lang.String password,
                               CognitoUserAttributes userAttributes,
                               java.util.Map<java.lang.String,java.lang.String> validationData,
                               SignUpHandler callback)

Runs user registration in background.

Parameters:

userId - REQUIRED: userId for this user

password - REQUIRED: Password for this user

userAttributes - REQUIRED: Contains all attributes for this user

validationData - REQUIRED: Parameters for lambda function for user registration

callback - REQUIRED: callback, must not be null

signUp

public void signUp(java.lang.String userId,
                   java.lang.String password,
                   CognitoUserAttributes userAttributes,
                   java.util.Map<java.lang.String,java.lang.String> validationData,
                   SignUpHandler callback)

Runs user registration in current thread.

Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.

Parameters:

userId - REQUIRED: userId for this user

password - REQUIRED: Password for this user

userAttributes - REQUIRED: Contains all attributes for this user

validationData - REQUIRED: Parameters for lambda function for user registration

callback - REQUIRED: callback, must not be null

signUpInBackground

public void signUpInBackground(java.lang.String userId,
                               java.lang.String password,
                               CognitoUserAttributes userAttributes,
                               java.util.Map<java.lang.String,java.lang.String> validationData,
                               java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                               SignUpHandler callback)

Runs user registration in background.

Parameters:

userId - REQUIRED: userId for this user

password - REQUIRED: Password for this user

userAttributes - REQUIRED: Contains all attributes for this user

validationData - REQUIRED: Parameters for lambda function for user registration

clientMetadata - Client metadata for lambda function for user registration

callback - REQUIRED: callback, must not be null

signUp

public void signUp(java.lang.String userId,
                   java.lang.String password,
                   CognitoUserAttributes userAttributes,
                   java.util.Map<java.lang.String,java.lang.String> validationData,
                   java.util.Map<java.lang.String,java.lang.String> clientMetadata,
                   SignUpHandler callback)

Runs user registration in current thread.

Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.

Parameters:

userId - REQUIRED: userId for this user

password - REQUIRED: Password for this user

userAttributes - REQUIRED: Contains all attributes for this user

validationData - REQUIRED: Parameters for lambda function for user registration

clientMetadata - Client metadata for lambda function for user registration

callback - REQUIRED: callback, must not be null

getCurrentUser

public CognitoUser getCurrentUser()

Returns last authenticated user on this device in this user pool.

Returns:

An instance of the CognitoUser for last authenticated, cached on this device

getUser

public CognitoUser getUser()

Returns a CognitoUser with no username set.

Returns:

CognitoUser.

getUser

public CognitoUser getUser(java.lang.String userId)

Returns a CognitoUser with userId userId

This CognitoUser is not authenticated. Call CognitoUser.getSession(AuthenticationHandler) to get valid tokens CognitoUserSession

Parameters:

userId - Can be null

Returns:

a new CognitoUser instance with userId userId