com.amazonaws.mobile.auth.userpools

Class CognitoUserPoolsSignInProvider

java.lang.Object

com.amazonaws.mobile.auth.userpools.CognitoUserPoolsSignInProvider

All Implemented Interfaces:

IdentityProvider, SignInProvider

public class CognitoUserPoolsSignInProvider
extends java.lang.Object
implements SignInProvider

Manages sign-in using Cognito User Pools.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CognitoUserPoolsSignInProvider.AttributeKeys Cognito User Pools attributes.

Constructor Summary

Constructors

Constructor and Description
CognitoUserPoolsSignInProvider()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCognitoLoginKey()
CognitoUserPool	getCognitoUserPool()
java.lang.String	getDisplayName()
java.lang.String	getToken() Call getToken to retrieve the access token from successful sign-in with this provider.
void	handleActivityResult(int requestCode, int resultCode, android.content.Intent data) Call handleActivityResult to handle the activity result.
void	initialize(android.content.Context context, AWSConfiguration awsConfiguration) Method called upon constructing an identity provider for it to handle its initialization.
android.view.View.OnClickListener	initializeSignInButton(android.app.Activity signInActivity, android.view.View buttonView, SignInProviderResultHandler providerResultsHandler) Initialize the sign-in button for the sign-in activity.
boolean	isRequestCodeOurs(int requestCode) Call isRequestCodeOurs to determine if this provider should handle an activity result.
java.lang.String	refreshToken() Refreshes the token if it has expired.
boolean	refreshUserSignInState() Refreshes the state of whether the user is signed-in and returns the updated state.
void	signOut() Call signOut to sign out of this provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoUserPoolsSignInProvider

public CognitoUserPoolsSignInProvider()

Method Detail

initialize

public void initialize(android.content.Context context,
                       AWSConfiguration awsConfiguration)

Method called upon constructing an identity provider for it to handle its initialization.

Specified by:

initialize in interface IdentityProvider

Parameters:

context - the context.

awsConfiguration - the configuration.

isRequestCodeOurs

public boolean isRequestCodeOurs(int requestCode)

Description copied from interface: SignInProvider

Call isRequestCodeOurs to determine if this provider should handle an activity result.

Specified by:

isRequestCodeOurs in interface SignInProvider

Parameters:

requestCode - the requestCode from a previous call to onActivityResult.

Returns:

true if the request code is from this provider, otherwise false.

handleActivityResult

public void handleActivityResult(int requestCode,
                                 int resultCode,
                                 android.content.Intent data)

Call handleActivityResult to handle the activity result.

Specified by:

handleActivityResult in interface SignInProvider

Parameters:

requestCode - the request code.

resultCode - the result code.

data - the result intent.

initializeSignInButton

public android.view.View.OnClickListener initializeSignInButton(android.app.Activity signInActivity,
                                                                android.view.View buttonView,
                                                                SignInProviderResultHandler providerResultsHandler)

Initialize the sign-in button for the sign-in activity.

Specified by:

initializeSignInButton in interface SignInProvider

Parameters:

signInActivity - the activity for sign-in.

buttonView - the view for the sign-in button to initialize.

providerResultsHandler - the resultsHandler for provider sign-in.

Returns:

the onClickListener for the button to be able to override the listener, and null if the button cannot be initialized.

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface IdentityProvider

Returns:

the display name for this provider.

getCognitoLoginKey

public java.lang.String getCognitoLoginKey()

Specified by:

getCognitoLoginKey in interface IdentityProvider

Returns:

the key used by Cognito in its login map when refreshing credentials.

refreshUserSignInState

public boolean refreshUserSignInState()

Refreshes the state of whether the user is signed-in and returns the updated state. Note: This call may block, so it must not be called from the main thread.

Specified by:

refreshUserSignInState in interface IdentityProvider

Returns:

true if signed in with this provider, otherwise false.

getToken

public java.lang.String getToken()

Call getToken to retrieve the access token from successful sign-in with this provider. Note: This call may block if the access token is not already cached.

Specified by:

getToken in interface IdentityProvider

Returns:

the access token suitable for use with Cognito.

refreshToken

public java.lang.String refreshToken()

Refreshes the token if it has expired. Note: this call may block due to network access, and must be called from a background thread.

Specified by:

refreshToken in interface IdentityProvider

Returns:

the refreshed access token, or null if the token cannot be refreshed.

signOut

public void signOut()

Call signOut to sign out of this provider.

Specified by:

signOut in interface IdentityProvider

getCognitoUserPool

public CognitoUserPool getCognitoUserPool()

Returns:

the Cognito User Pool.