com.amazonaws.mobileconnectors.cognitoidentityprovider.util

Class CognitoDeviceHelper

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.util.CognitoDeviceHelper

public final class CognitoDeviceHelper
extends java.lang.Object

A utility class for device operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CognitoDeviceHelper.deviceSRP Static class for SRP related calculations for devices.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DEVICE_PAGINATION_LIMIT Default pagination limit.

Constructor Summary

Constructors

Constructor and Description
CognitoDeviceHelper()

Method Summary

Modifier and Type	Method and Description
static void	cacheDeviceGroupKey(java.lang.String username, java.lang.String userPoolId, java.lang.String deviceGroupKey, android.content.Context context) This method caches the device group key.
static void	cacheDeviceKey(java.lang.String username, java.lang.String userPoolId, java.lang.String deviceKey, android.content.Context context) This method caches the device key.
static void	cacheDeviceVerifier(java.lang.String username, java.lang.String userPoolId, java.lang.String deviceSecret, android.content.Context context) This method caches the device verifier.
static void	clearCachedDevice(java.lang.String username, java.lang.String userPoolId, android.content.Context context) Clears cached device details for this user.
static java.lang.String	generateRandomString() Returns a string with random characters.
static java.util.Map<java.lang.String,java.lang.String>	generateVerificationParameters(java.lang.String deviceKey, java.lang.String deviceGroup) Generates SRP verification parameters for device verification.
static java.lang.String	getDeviceGroupKey(java.lang.String username, java.lang.String userPoolId, android.content.Context context) Returns the cached device group key for this device.
static java.lang.String	getDeviceKey(java.lang.String username, java.lang.String userPoolId, android.content.Context context) Returns the cached key for this device.
static java.lang.String	getDeviceName() Uses the Android class Build to return the model of the android device.
static java.lang.String	getDeviceSecret(java.lang.String username, java.lang.String userPoolId, android.content.Context context) Returns the cached device secret for this device.
static void	setPersistenceEnabled(boolean isPersistenceEnabled) Set the flag that indicates if the persistence is enabled or not.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEVICE_PAGINATION_LIMIT

public static final int DEFAULT_DEVICE_PAGINATION_LIMIT

Default pagination limit.

See Also:

Constant Field Values

Constructor Detail

CognitoDeviceHelper

public CognitoDeviceHelper()

Method Detail

setPersistenceEnabled

public static void setPersistenceEnabled(boolean isPersistenceEnabled)

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

Parameters:

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

getDeviceName

public static java.lang.String getDeviceName()

Uses the Android class Build to return the model of the android device.

Returns:

Device model name, which is also the name of the device.

getDeviceKey

public static java.lang.String getDeviceKey(java.lang.String username,
                                            java.lang.String userPoolId,
                                            android.content.Context context)

Returns the cached key for this device. Device keys are stored in SharedPreferences and are used to track devices. Returns null if no device key was cached.

Parameters:

username - REQUIRED: The current user.

userPoolId - REQUIRED: Client ID of the application.

context - REQUIRED: Application context.

Returns:

device key as String, null if the device-key is not available.

getDeviceSecret

public static java.lang.String getDeviceSecret(java.lang.String username,
                                               java.lang.String userPoolId,
                                               android.content.Context context)

Returns the cached device secret for this device. Device secret is generated when the device is confirmed and is used for device identification.

Parameters:

username - REQUIRED: The current user.

userPoolId - REQUIRED: Client ID of the application.

context - REQUIRED: Application context.

Returns:

device secret as String, null if the device-key is not available.

getDeviceGroupKey

public static java.lang.String getDeviceGroupKey(java.lang.String username,
                                                 java.lang.String userPoolId,
                                                 android.content.Context context)

Returns the cached device group key for this device. Device secret is generated when the device is confirmed and is used for device identification.

Parameters:

username - REQUIRED: The current user.

userPoolId - REQUIRED: Client ID of the application.

context - REQUIRED: Application context.

Returns:

device group key as String, null if the device-key is not available.

cacheDeviceKey

public static void cacheDeviceKey(java.lang.String username,
                                  java.lang.String userPoolId,
                                  java.lang.String deviceKey,
                                  android.content.Context context)

This method caches the device key. Device key is assigned by the Amazon Cognito service and is used as a device identifier.

Parameters:

username - REQUIRED: The current user.

userPoolId - REQUIRED: Client ID of the device.

deviceKey - REQUIRED: Cognito assigned device key.

context - REQUIRED: App context, needed to access device datastore.

cacheDeviceVerifier

public static void cacheDeviceVerifier(java.lang.String username,
                                       java.lang.String userPoolId,
                                       java.lang.String deviceSecret,
                                       android.content.Context context)

This method caches the device verifier. Device verifier is generated locally by the SDK and it is used to authenticate the device through device SRP authentication.

Parameters:

username - REQUIRED: The current user.

userPoolId - REQUIRED: Client ID of the device.

deviceSecret - REQUIRED: Cognito assigned device key.

context - REQUIRED: App context, needed to access device datastore.

cacheDeviceGroupKey

public static void cacheDeviceGroupKey(java.lang.String username,
                                       java.lang.String userPoolId,
                                       java.lang.String deviceGroupKey,
                                       android.content.Context context)

This method caches the device group key. Device verifier is generated locally by the SDK and it is used to authenticate the device through device SRP authentication.

Parameters:

username - REQUIRED: The current user.

userPoolId - REQUIRED: Client ID of the device.

deviceGroupKey - REQUIRED: Cognito assigned device group key.

context - REQUIRED: App context, needed to access device datastore.

clearCachedDevice

public static void clearCachedDevice(java.lang.String username,
                                     java.lang.String userPoolId,
                                     android.content.Context context)

Clears cached device details for this user.

Parameters:

username - REQUIRED: The current user.

userPoolId - REQUIRED: Client ID of the device.

context - REQUIRED: App context, needed to access device datastore.

generateVerificationParameters

public static java.util.Map<java.lang.String,java.lang.String> generateVerificationParameters(java.lang.String deviceKey,
                                                                                              java.lang.String deviceGroup)

Generates SRP verification parameters for device verification.

Parameters:

deviceKey - REQUIRED: Username this device belongs to.

deviceGroup - REQUIRED: This is the device group id returned by the service.

Returns:

srp verification details for this device, as a Map.

generateRandomString

public static java.lang.String generateRandomString()

Returns a string with random characters.

Returns:

a string with random alpha-numeric characters.s