com.gemalto.idp.mobile.securestorage

Class SecureStorageModule

java.lang.Object

com.gemalto.idp.mobile.securestorage.SecureStorageModule

public class SecureStorageModule
extends java.lang.Object

SecureStorageModule class which is the entry-point for SecureStorage features.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
static SecureStorageModule	create() Create SecureStorageModule object.
SecureStorageManager	getSecureStorageManager() Get SecureStorageManager.
boolean	isMigrationNeededForAndroidQ(java.lang.String storageIdentifier, DeviceFingerprintSource dfs) Check if the migration is needed for Android Q with the given storage identifier.
void	migrateForAndroidQ(java.lang.String storageIdentifier, DeviceFingerprintSource dfs) Migrate the old secure storage data to be compatible with Android Q.
boolean	reset(java.lang.String storageIdentifier) Cleanup the data associated with given storageIdentifier.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SecureStorageModule create()

Create SecureStorageModule object.

Returns:

SecureStorage Module.

getSecureStorageManager

public SecureStorageManager getSecureStorageManager()

Get SecureStorageManager.

Returns:

SecureStorageManager object.

reset

public boolean reset(java.lang.String storageIdentifier)
              throws IdpSecureStorageException

Cleanup the data associated with given storageIdentifier.

Parameters:

storageIdentifier - the name of the storage to be cleaned up.

Returns:

true if reset is successful.

Throws:

IdpSecureStorageException - when database operation failed.

Since:

4.9.0

See Also:

IdpCore.reset()

isMigrationNeededForAndroidQ

public boolean isMigrationNeededForAndroidQ(java.lang.String storageIdentifier,
                                            DeviceFingerprintSource dfs)
                                     throws IdpSecureStorageException

Check if the migration is needed for Android Q with the given storage identifier. If the migration is needed, app should ask the end user for the permission READ_PHONE_STATE and then call the migration API migrateForAndroidQ(String, DeviceFingerprintSource).

NOTE: This API should be called during the application startup to make sure that the permission popup, if any, will not interfere with other business flow.

For more information on Android Q privacy changes, refer to https://developer.android.com/preview/privacy/data-identifiers#device-ids

Parameters:

storageIdentifier - The storage identifier need to be checked.

dfs - The device fingerprint source.

Returns:

true if migration is needed, otherwise false.

Throws:

IdpSecureStorageException - When database operation failed.

Since:

4.9.2

See Also:

migrateForAndroidQ(String, DeviceFingerprintSource)

migrateForAndroidQ

public void migrateForAndroidQ(java.lang.String storageIdentifier,
                               DeviceFingerprintSource dfs)
                        throws IdpSecureStorageException

Migrate the old secure storage data to be compatible with Android Q. In order to retrieve the old data, this API needs the READ_PHONE_STATE permission to be granted. After the migration, the permission is not required anymore.

For more information on Android Q privacy changes, refer to https://developer.android.com/preview/privacy/data-identifiers#device-ids

Parameters:

storageIdentifier - The name of the storage to be migrated.

dfs - The device fingerprint source.

Throws:

IdpSecureStorageException - When database operation failed.

Since:

4.9.2

See Also:

isMigrationNeededForAndroidQ(String, DeviceFingerprintSource)