com.gemalto.idp.mobile.otp

Class OtpModule

java.lang.Object

com.gemalto.idp.mobile.otp.OtpModule

public class OtpModule
extends java.lang.Object

OtpModule class which is the entry-point for OTP features.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
static OtpModule	create() Create OtpModule object.
boolean	isMigrationNeededForAndroidQ(java.lang.String tokenName) Check if the migration is needed for Android Q with the given token name.
void	migrateForAndroidQ(java.lang.String tokenName, byte[] customData) Migrate the old token to be compatible with Android Q.
boolean	reset() Cleanup the data associated with OTP module.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static OtpModule create()

Create OtpModule object.

Returns:

Otp Module.

isMigrationNeededForAndroidQ

public boolean isMigrationNeededForAndroidQ(java.lang.String tokenName)
                                     throws IdpException

Check if the migration is needed for Android Q with the given token name. 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, byte[]).

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:

tokenName - The token name.

Returns:

true if migration is needed, otherwise false.

Throws:

IdpStorageException - When database operation failed.

PasswordManagerException - When the TOKEN domain is not logged in using the password manager.

IdpException

Since:

4.9.2

See Also:

migrateForAndroidQ(String, byte[])

migrateForAndroidQ

public void migrateForAndroidQ(java.lang.String tokenName,
                               byte[] customData)
                        throws IdpException

Migrate the old token to be compatible with Android Q. In order to retrieve the old token, 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:

tokenName - The name of the token to be migrated.

customData - The custom data.

Throws:

IdpStorageException - When database operation failed.

PasswordManagerException - When the TOKEN domain is not logged in using the password manager.

DeviceFingerprintException - When the fingerprint data does not match.

IdpException

Since:

4.9.2

See Also:

isMigrationNeededForAndroidQ(String)

reset

public boolean reset()
              throws IdpException

Cleanup the data associated with OTP module. Tokens that have been provisioned before will be removed.

Returns:

true if rest is successful.

Throws:

IdpException - when database operation failed.

Since:

4.9.0

See Also:

IdpCore.reset()