com.amazonaws.auth

Class AWSAbstractCognitoIdentityProvider

java.lang.Object

com.amazonaws.auth.AWSAbstractCognitoIdentityProvider

All Implemented Interfaces:

AWSCognitoIdentityProvider, AWSIdentityProvider

Direct Known Subclasses:

AWSAbstractCognitoDeveloperIdentityProvider, AWSBasicCognitoIdentityProvider, AWSEnhancedCognitoIdentityProvider

public abstract class AWSAbstractCognitoIdentityProvider
extends Object
implements AWSCognitoIdentityProvider

This class utilizes Cognito as a means to get an identity and dispense an identityId and token. It also handles the refreshing of the token and identityId.

Field Summary

Fields

Modifier and Type	Field and Description
protected AmazonCognitoIdentity	cib The client for communication with Cognito
protected String	identityId The data structures that won't vary between cognito and developer providers
protected List<IdentityChangedListener>	listeners
protected Map<String,String>	loginsMap
protected String	token

Constructor Summary

Constructors

Constructor and Description
AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId) Deprecated. please use AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId, Regions region) instead.
AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId, AmazonCognitoIdentity cibClient) Sets up an AWSAbstractCognitoIdentityProvider, which will serve as the baseline for both Cognito and developer trusted identity providers.
AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId, ClientConfiguration clientConfiguration) Deprecated. please use AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId, ClientConfiguration clientConfiguration, Regions region) instead.
AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId, ClientConfiguration clientConfiguration, Regions region) Sets up an AWSAbstractCognitoIdentityProvider, which will serve as the baseline for both Cognito and developer trusted identity providers.
AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId, Regions region) Sets up an AWSAbstractCognitoIdentityProvider, which will serve as the baseline for both Cognito and developer trusted identity providers.

Method Summary

Modifier and Type	Method and Description
protected void	appendUserAgent(AmazonWebServiceRequest request, String userAgent) Append user agent string to the request.
void	clearListeners() To be used to empty all registered listeners from the identity provider
String	getAccountId()
String	getIdentityId() Gets a reference to the identityId of the user (sending a new request if it isn't yet set), using the dev accountId, identityPoolId, and the user's loginsMap to identify.
String	getIdentityPoolId() Get the identityPoolId from the provider
Map<String,String>	getLogins() Get the logins from the provider
abstract String	getProviderName() Gets a string with the name of the provider being used.
String	getToken() With the logins and identityId to mark the user, it builds a request to the cognito back end, and returns the token cib hands back
protected String	getUserAgent() Gets the user agent string to append to all requests made by this provider.
void	identityChanged(String newIdentityId) Updates the listeners and establishes the new identityId as the stored identityId
boolean	isAuthenticated() Checks if the current identityId belongs to an authenticated user
String	refresh() To be used to call the provider back end to get a token and identityId.
void	registerIdentityChangedListener(IdentityChangedListener listener) Handles the new version of an identity changed listener to be handled by the provider
protected void	setIdentityId(String identityId)
void	setLogins(Map<String,String> logins) Pass the logins to the provider
protected void	setToken(String token)
void	unregisterIdentityChangedListener(IdentityChangedListener listener) Handles the removing of a version of an identity changed listener from the list with the provider
protected void	update(String identityId, String token) To be used to update the identityId and token after a call to refresh from an identityProvider.

Methods inherited from class java.lang.Object

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

Field Detail

cib

protected final AmazonCognitoIdentity cib

The client for communication with Cognito

identityId

protected String identityId

The data structures that won't vary between cognito and developer providers

token

protected String token

listeners

protected List<IdentityChangedListener> listeners

loginsMap

protected Map<String,String> loginsMap

Constructor Detail

AWSAbstractCognitoIdentityProvider

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

Sets up an AWSAbstractCognitoIdentityProvider, which will serve as the baseline for both Cognito and developer trusted identity providers. Custom providers should not extend this class, but should extend AWSAbstractCognitoDeveloperIdentityProvider

Parameters:

accountId - the accountId of the developer

identityPoolId - the identityPoolId to be used

cibClient - the cib client which will communicate with cognito

AWSAbstractCognitoIdentityProvider

@Deprecated
public AWSAbstractCognitoIdentityProvider(String accountId,
                                                      String identityPoolId,
                                                      ClientConfiguration clientConfiguration)

Deprecated. please use AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId, ClientConfiguration clientConfiguration, Regions region) instead.

Sets up an AWSAbstractCognitoIdentityProvider, which will serve as the baseline for both Cognito and developer trusted identity providers. Custom providers should not extend this class, but should extend AWSAbstractCognitoDeveloperIdentityProvider

Parameters:

accountId - the accountId of the developer

identityPoolId - the identityPoolId to be used

clientConfiguration - the client configuration to be used by the client

AWSAbstractCognitoIdentityProvider

public AWSAbstractCognitoIdentityProvider(String accountId,
                                          String identityPoolId,
                                          ClientConfiguration clientConfiguration,
                                          Regions region)

Sets up an AWSAbstractCognitoIdentityProvider, which will serve as the baseline for both Cognito and developer trusted identity providers. Custom providers should not extend this class, but should extend AWSAbstractCognitoDeveloperIdentityProvider

Parameters:

accountId - the accountId of the developer

identityPoolId - the identityPoolId to be used

clientConfiguration - the client configuration to be used by the client

region - the region cognito will use

AWSAbstractCognitoIdentityProvider

@Deprecated
public AWSAbstractCognitoIdentityProvider(String accountId,
                                                      String identityPoolId)

Deprecated. please use AWSAbstractCognitoIdentityProvider(String accountId, String identityPoolId, Regions region) instead.

Sets up an AWSAbstractCognitoIdentityProvider, which will serve as the baseline for both Cognito and developer trusted identity providers. Custom providers should not extend this class, but should extend AWSAbstractCognitoDeveloperIdentityProvider

Parameters:

accountId - the accountId of the developer

identityPoolId - the identityPoolId to be used

AWSAbstractCognitoIdentityProvider

public AWSAbstractCognitoIdentityProvider(String accountId,
                                          String identityPoolId,
                                          Regions region)

Sets up an AWSAbstractCognitoIdentityProvider, which will serve as the baseline for both Cognito and developer trusted identity providers. Custom providers should not extend this class, but should extend AWSAbstractCognitoDeveloperIdentityProvider

Parameters:

accountId - the accountId of the developer

identityPoolId - the identityPoolId to be used

region - the region cib will use

Method Detail

getProviderName

public abstract String getProviderName()

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

Returns:

the name of the provider in a string

getIdentityId

public String getIdentityId()

Gets a reference to the identityId of the user (sending a new request if it isn't yet set), using the dev accountId, identityPoolId, and the user's loginsMap to identify.

Specified by:

getIdentityId in interface AWSCognitoIdentityProvider

Returns:

the identityId of the user

setIdentityId

protected void setIdentityId(String identityId)

getToken

public String getToken()

With the logins and identityId to mark the user, it builds a request to the cognito back end, and returns the token cib hands back

Specified by:

getToken in interface AWSIdentityProvider

Returns:

the token which was retrieved from the provider

setToken

protected void setToken(String token)

getIdentityPoolId

public String getIdentityPoolId()

Description copied from interface: AWSCognitoIdentityProvider

Get the identityPoolId from the provider

Specified by:

getIdentityPoolId in interface AWSCognitoIdentityProvider

Returns:

the identityPoolId

getAccountId

public String getAccountId()

getLogins

public Map<String,String> getLogins()

Description copied from interface: AWSCognitoIdentityProvider

Get the logins from the provider

Specified by:

getLogins in interface AWSCognitoIdentityProvider

Returns:

the logins map

setLogins

public void setLogins(Map<String,String> logins)

Description copied from interface: AWSCognitoIdentityProvider

Pass the logins to the provider

Specified by:

setLogins in interface AWSCognitoIdentityProvider

Parameters:

logins - the logins map

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: AWSCognitoIdentityProvider

Checks if the current identityId belongs to an authenticated user

Specified by:

isAuthenticated in interface AWSCognitoIdentityProvider

Returns:

true if the identity is authenticated

unregisterIdentityChangedListener

public void unregisterIdentityChangedListener(IdentityChangedListener listener)

Description copied from interface: AWSCognitoIdentityProvider

Handles the removing of a version of an identity changed listener from the list with the provider

Specified by:

unregisterIdentityChangedListener in interface AWSCognitoIdentityProvider

Parameters:

listener - the listener to be removed

registerIdentityChangedListener

public void registerIdentityChangedListener(IdentityChangedListener listener)

Description copied from interface: AWSCognitoIdentityProvider

Handles the new version of an identity changed listener to be handled by the provider

Specified by:

registerIdentityChangedListener in interface AWSCognitoIdentityProvider

Parameters:

listener - the new listener to be registered

identityChanged

public void identityChanged(String newIdentityId)

Updates the listeners and establishes the new identityId as the stored identityId

Specified by:

identityChanged in interface AWSCognitoIdentityProvider

Parameters:

newIdentityId - the identityId to be saved

appendUserAgent

protected void appendUserAgent(AmazonWebServiceRequest request,
                               String userAgent)

Append user agent string to the request. The final string is what is set in the ClientCofniguration concatenated with the given userAgent string.

Parameters:

request - the request object to be appended

userAgent - additional user agent string to append

clearListeners

public void clearListeners()

Description copied from interface: AWSCognitoIdentityProvider

To be used to empty all registered listeners from the identity provider

Specified by:

clearListeners in interface AWSCognitoIdentityProvider

getUserAgent

protected String getUserAgent()

Gets the user agent string to append to all requests made by this provider. Default is an empty string.

Returns:

the user agent string

update

protected void update(String identityId,
                      String token)

To be used to update the identityId and token after a call to refresh from an identityProvider. Note, this is the only call that is needed after the refresh call terminates, and it is explicitly necessary. Do not call setIdentity and/or setToken in addition to this, or it could cause unexpected behavior.

Parameters:

identityId - the new identityId to be used for the user

token - the new token to be used with STS

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

Returns:

token returns the token that was updated in the refresh