com.amazonaws.mobile.auth.core

Class IdentityManager

java.lang.Object

com.amazonaws.mobile.auth.core.IdentityManager

public class IdentityManager
extends java.lang.Object

The identity manager keeps track of the current sign-in provider and is responsible for caching credentials.

 // Create IdentityManager and set it as the default instance.
 IdentityManager idm = new IdentityManager(getApplicationContext(),
                                           new AWSConfiguration(getApplicationContext()));
 IdentityManager.setDefaultIdentityManager(idm);

 // Use IdentityManager to retrieve the CognitoCachingCredentialsProvider
 // object.
 IdentityManager.getDefaultIdentityManager().getUnderlyingProvider();

 

Constructor Summary

Constructors

Constructor and Description
IdentityManager(android.content.Context context) Constructor that takes in the application context.
IdentityManager(android.content.Context context, AWSConfiguration awsConfiguration) Constructor.
IdentityManager(android.content.Context context, AWSConfiguration awsConfiguration, ClientConfiguration clientConfiguration) Constructor.
IdentityManager(android.content.Context context, CognitoCachingCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addSignInProvider(java.lang.Class<? extends SignInProvider> providerClass) Add a supported identity provider to your app.
void	addSignInStateChangeListener(SignInStateChangeListener listener) Add a listener to receive callbacks when sign-in or sign-out occur.
boolean	areCredentialsExpired() Check if the short-lived AWS Credentials are expired.
void	doStartupAuth(android.app.Activity callingActivity, StartupAuthResultHandler startupAuthResultHandler) Deprecated. Please use resumeSession(Activity, StartupAuthResultHandler) method instead.
void	doStartupAuth(android.app.Activity callingActivity, StartupAuthResultHandler startupAuthResultHandler, long minimumDelay) Deprecated. Please use resumeSession(Activity, StartupAuthResultHandler, long) method instead.
void	enableFederation(boolean enabled) Set the flag that indicates if tokens will be federated into Cognito Identity pool
void	expireSignInTimeout() Call this to ignore waiting for the remaining timeout delay.
void	federateWithProvider(IdentityProvider provider) Fetch the token from the SignIn provider and insert into the loginMap and then invoke refreshCredentialWithLogins(Map) to set the loginsMap with the CredentialsProvider object in-order to federate the token with Amazon Cognito Federated Identities.
java.lang.String	getCachedUserID() Gets the cached unique identifier for the user.
AWSConfiguration	getConfiguration() Retrieve the AWSConfiguration object that represents the `awsconfiguration.json`.
AWSCredentialsProvider	getCredentialsProvider() Retrieve the reference to AWSCredentialsProvider object.
IdentityProvider	getCurrentIdentityProvider() Gets the current provider.
static IdentityManager	getDefaultIdentityManager() Return the default instance of the IdentityManager
com.amazonaws.mobile.auth.core.IdentityManager.SignInProviderResultAdapter	getResultsAdapter() Call getResultsAdapter to get the IdentityManager's handler that adapts results before sending them back to the handler set by setProviderResultsHandler(SignInProviderResultHandler)
java.util.Collection<java.lang.Class<? extends SignInProvider>>	getSignInProviderClasses() Gets the list of SignInProvider classes
CognitoCachingCredentialsProvider	getUnderlyingProvider() Retrieve the reference to CognitoCachingCredentialsProvider object.
void	getUserID(IdentityHandler handler) Gets the user's unique identifier.
boolean	isUserSignedIn() Check if user is signed in.
void	login(android.content.Context context, SignInResultHandler signInResultHandler) Call login to initiate sign-in with a provider.
void	removeSignInStateChangeListener(SignInStateChangeListener listener) Remove a listener from receiving callbacks when sign-in or sign-out occur.
void	resumeSession(android.app.Activity callingActivity, StartupAuthResultHandler startupAuthResultHandler) This should be called from your app's splash activity upon start-up.
void	resumeSession(android.app.Activity callingActivity, StartupAuthResultHandler startupAuthResultHandler, long minimumDelay) This should be called from your app's activity upon start-up.
void	setConfiguration(AWSConfiguration configuration) Set the AWSConfiguration.
static void	setDefaultIdentityManager(IdentityManager identityManager) Set the IdentityManager object passed in as the default instance
void	setPersistenceEnabled(boolean persistenceEnabled) Set the flag that indicates if persistence is enabled or not.
void	setProviderResultsHandler(SignInProviderResultHandler signInProviderResultHandler) Set the results handler that will be used for results when calling federateWithProvider.
void	setUpToAuthenticate(android.content.Context context, SignInResultHandler signInResultHandler) Deprecated. Please use login(Context, SignInResultHandler) method instead.
void	signOut() Sign out of the current identity provider, and clear Cognito credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityManager

public IdentityManager(android.content.Context context)

Constructor that takes in the application context.

Parameters:

context - the application context.

IdentityManager

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

Constructor. Initializes with the application context and the AWSConfiguration passed in. Creates a default ClientConfiguration with the user agent from AWSConfiguration.

Parameters:

context - the application context.

awsConfiguration - the aws configuration.

IdentityManager

public IdentityManager(android.content.Context context,
                       AWSConfiguration awsConfiguration,
                       ClientConfiguration clientConfiguration)

Constructor. Initializes with the application context, the AWSConfiguration and the ClientConfiguration passed in. Read the UserAgent from AWSConfiguration and set in ClientConfiguration.

Parameters:

context - the application context.

awsConfiguration - the aws configuration.

clientConfiguration - the client configuration options such as retries and timeouts.

IdentityManager

public IdentityManager(android.content.Context context,
                       CognitoCachingCredentialsProvider credentialsProvider,
                       ClientConfiguration clientConfiguration)

Constructor.

Parameters:

context - application context

credentialsProvider - credentials provider to talk with Cognito Identity

clientConfiguration - the client configuration options such as retries and timeouts

Method Detail

setPersistenceEnabled

public void setPersistenceEnabled(boolean persistenceEnabled)

Set the flag that indicates if persistence is enabled or not.

Parameters:

persistenceEnabled - the flag that indicates if persistence is enabled or not.

enableFederation

public void enableFederation(boolean enabled)

Set the flag that indicates if tokens will be federated into Cognito Identity pool

Parameters:

enabled - Flag that indicates if tokens will be federated into Cognito Identity pool

getDefaultIdentityManager

public static IdentityManager getDefaultIdentityManager()

Return the default instance of the IdentityManager

Returns:

defaultIdentityManager The default IdentityManager object

setDefaultIdentityManager

public static void setDefaultIdentityManager(IdentityManager identityManager)

Set the IdentityManager object passed in as the default instance

Parameters:

identityManager - The IdentityManager object to be set as the default

getConfiguration

public AWSConfiguration getConfiguration()

Retrieve the AWSConfiguration object that represents the `awsconfiguration.json`.

Returns:

AWSConfiguration Return the reference to the AWSConfiguration object

setConfiguration

public void setConfiguration(AWSConfiguration configuration)

Set the AWSConfiguration.

Parameters:

configuration -

areCredentialsExpired

public boolean areCredentialsExpired()

Check if the short-lived AWS Credentials are expired.

Returns:

true if the cached short-lived AWS credentials are expired, otherwise false.

getCredentialsProvider

public AWSCredentialsProvider getCredentialsProvider()

Retrieve the reference to AWSCredentialsProvider object.

Returns:

the holder to the CognitoCachingCredentialsProvider.

getUnderlyingProvider

public CognitoCachingCredentialsProvider getUnderlyingProvider()

Retrieve the reference to CognitoCachingCredentialsProvider object.

Returns:

the Cognito Caching Credentials Provider

getCachedUserID

public java.lang.String getCachedUserID()

Gets the cached unique identifier for the user.

Returns:

the cached unique identifier for the user.

getUserID

public void getUserID(IdentityHandler handler)

Gets the user's unique identifier. This method can be called from any thread.

Parameters:

handler - handles the unique identifier for the user

addSignInStateChangeListener

public void addSignInStateChangeListener(SignInStateChangeListener listener)

Add a listener to receive callbacks when sign-in or sign-out occur. The listener methods will always be called on a background thread.

Parameters:

listener - the sign-in state change listener.

removeSignInStateChangeListener

public void removeSignInStateChangeListener(SignInStateChangeListener listener)

Remove a listener from receiving callbacks when sign-in or sign-out occur.

Parameters:

listener - the sign-in state change listener.

getResultsAdapter

public com.amazonaws.mobile.auth.core.IdentityManager.SignInProviderResultAdapter getResultsAdapter()

Call getResultsAdapter to get the IdentityManager's handler that adapts results before sending them back to the handler set by setProviderResultsHandler(SignInProviderResultHandler)

Returns:

the Identity Manager's results adapter.

signOut

public void signOut()

Sign out of the current identity provider, and clear Cognito credentials. Note: This call does not attempt to obtain un-auth credentials. To obtain an unauthenticated anonymous (guest) identity, call getUserID(IdentityHandler).

setProviderResultsHandler

public void setProviderResultsHandler(SignInProviderResultHandler signInProviderResultHandler)

Set the results handler that will be used for results when calling federateWithProvider.

Parameters:

signInProviderResultHandler - the results handler.

federateWithProvider

public void federateWithProvider(IdentityProvider provider)

Fetch the token from the SignIn provider and insert into the loginMap and then invoke refreshCredentialWithLogins(Map) to set the loginsMap with the CredentialsProvider object in-order to federate the token with Amazon Cognito Federated Identities.

Parameters:

provider - A sign-in provider.

getCurrentIdentityProvider

public IdentityProvider getCurrentIdentityProvider()

Gets the current provider.

Returns:

current provider or null if not signed-in

addSignInProvider

public void addSignInProvider(java.lang.Class<? extends SignInProvider> providerClass)

Add a supported identity provider to your app. The provider will be presented as option to sign in to your app.

Parameters:

providerClass - the provider class for the identity provider.

getSignInProviderClasses

public java.util.Collection<java.lang.Class<? extends SignInProvider>> getSignInProviderClasses()

Gets the list of SignInProvider classes

Returns:

list of the signInProvider classes

isUserSignedIn

public boolean isUserSignedIn()

Check if user is signed in.

Returns:

true if Cognito credentials have been obtained with at least one provider.

resumeSession

public void resumeSession(android.app.Activity callingActivity,
                          StartupAuthResultHandler startupAuthResultHandler,
                          long minimumDelay)

This should be called from your app's activity upon start-up. If the user was previously signed-in, this will attempt to refresh their identity using the previously signed-in provider. If the user was not previously signed in or their identity could not be refreshed with the previously signed-in provider, it will attempt to obtain an unauthenticated identity.

Parameters:

callingActivity - the calling activity.

startupAuthResultHandler - a handler for returning results.

minimumDelay - the minimum delay to wait before returning the sign-in result.

resumeSession

public void resumeSession(android.app.Activity callingActivity,
                          StartupAuthResultHandler startupAuthResultHandler)

This should be called from your app's splash activity upon start-up. If the user was previously signed in, this will attempt to refresh their identity using the previously sign-ed in provider. If the user was not previously signed in or their identity could not be refreshed with the previously signed in provider and sign-in is optional, it will attempt to obtain an unauthenticated (guest) identity.

Parameters:

callingActivity - the calling activity.

startupAuthResultHandler - a handler for returning results.

doStartupAuth

@Deprecated
public void doStartupAuth(android.app.Activity callingActivity,
                                      StartupAuthResultHandler startupAuthResultHandler)

Deprecated. Please use resumeSession(Activity, StartupAuthResultHandler) method instead.

This should be called from your app's splash activity upon start-up. If the user was previously signed in, this will attempt to refresh their identity using the previously sign-ed in provider. If the user was not previously signed in or their identity could not be refreshed with the previously signed in provider and sign-in is optional, it will attempt to obtain an unauthenticated (guest) identity.

Parameters:

callingActivity - the calling activity.

startupAuthResultHandler - a handler for returning results.

doStartupAuth

@Deprecated
public void doStartupAuth(android.app.Activity callingActivity,
                                      StartupAuthResultHandler startupAuthResultHandler,
                                      long minimumDelay)

Deprecated. Please use resumeSession(Activity, StartupAuthResultHandler, long) method instead.

This should be called from your app's splash activity upon start-up. If the user was previously signed in, this will attempt to refresh their identity using the previously sign-ed in provider. If the user was not previously signed in or their identity could not be refreshed with the previously signed in provider and sign-in is optional, it will attempt to obtain an unauthenticated (guest) identity.

Parameters:

callingActivity - the calling activity.

startupAuthResultHandler - a handler for returning results.

expireSignInTimeout

public void expireSignInTimeout()

Call this to ignore waiting for the remaining timeout delay.

setUpToAuthenticate

@Deprecated
public void setUpToAuthenticate(android.content.Context context,
                                            SignInResultHandler signInResultHandler)

Deprecated. Please use login(Context, SignInResultHandler) method instead.

Call setUpToAuthenticate to initiate sign-in with a provider. Note: This should not be called when already signed in with a provider.

Parameters:

context - context.

signInResultHandler - the results handler.

login

public void login(android.content.Context context,
                  SignInResultHandler signInResultHandler)

Call login to initiate sign-in with a provider. Note: This should not be called when already signed in with a provider.

Parameters:

context - context.

signInResultHandler - the results handler.