com.gemalto.idp.mobile.oob

Class OobModule

java.lang.Object

com.gemalto.idp.mobile.oob.OobModule

public class OobModule
extends java.lang.Object

OobModule class which is the entry-point for OOB features.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
static OobModule	create() Create OobModule object.
OobManager	createOobManager(java.net.URL oobUrl, java.lang.String domain, java.lang.String applicationId, byte[] rsaExponent, byte[] rsaModulus) Create OobManager object.
OobManager	createOobManager(java.net.URL oobUrl, java.lang.String domain, java.lang.String applicationId, java.security.interfaces.RSAPublicKey publicKey) Create OobManager object.
java.util.Set<java.lang.String>	getClientIDs(java.lang.String applicationId) Retrieve the Set of clientIds for given application ID
boolean	isMigrationNeededForAndroidQ(java.lang.String applicationId) Check if the migration is needed for Android Q with the given application identifier.
void	migrateForAndroidQ(java.lang.String applicationId) Migrate the old data to be compatible with Android Q.
boolean	reset(java.lang.String applicationId) Cleanup the data associated with Oob module.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static OobModule create()

Create OobModule object.

Returns:

Oob Module.

Since:

4.0

createOobManager

public OobManager createOobManager(java.net.URL oobUrl,
                                   java.lang.String domain,
                                   java.lang.String applicationId,
                                   byte[] rsaExponent,
                                   byte[] rsaModulus)

Create OobManager object.

Parameters:

oobUrl - the URL of the OOB server.

domain - the domain to use for requests to the OOB server. It must be compliant with server configuration on back-end side.

applicationId - the application identifier to use for requests to the OOB server.

rsaExponent - the RSA public exponent to use to communicate with the OOB server.

rsaModulus - the RSA modules to use to communicate with the OOB server.

Returns:

OobManager.

Since:

4.0

createOobManager

public OobManager createOobManager(java.net.URL oobUrl,
                                   java.lang.String domain,
                                   java.lang.String applicationId,
                                   java.security.interfaces.RSAPublicKey publicKey)

Create OobManager object.

Parameters:

oobUrl - the URL of the OOB server.

domain - the domain to use for requests to the OOB server. It must be compliant with server configuration on back-end side.

applicationId - the application identifier to use for requests to the OOB server.

publicKey - The RSA public key to communicate with OOB server.

Returns:

OobManager.

Since:

4.0

reset

public boolean reset(java.lang.String applicationId)

Cleanup the data associated with Oob module. All registered client will be removed for the given applicationId.

Parameters:

applicationId - the applicationId.

Returns:

true if reset is successful.

Since:

4.9.0

See Also:

IdpCore.reset()

isMigrationNeededForAndroidQ

public boolean isMigrationNeededForAndroidQ(java.lang.String applicationId)

Check if the migration is needed for Android Q with the given application 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).

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:

applicationId - The application ID.

Returns:

true if migration is needed.

Since:

4.9.2

See Also:

migrateForAndroidQ(String)

migrateForAndroidQ

public void migrateForAndroidQ(java.lang.String applicationId)
                        throws OobException

Migrate the old 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:

applicationId - The application ID.

Throws:

OobException - When database operation failed.

Since:

4.9.2

See Also:

isMigrationNeededForAndroidQ(String)

getClientIDs

public java.util.Set<java.lang.String> getClientIDs(java.lang.String applicationId)
                                             throws OobException

Retrieve the Set of clientIds for given application ID

Parameters:

applicationId - The application ID.

Returns:

set of clienIDs

Throws:

OobException - When the SDK is not able to retrieve the clientIDs. It can be caused by Database IO exception, passwordManager not logged in, or invalid DeviceFingerprint.

Since:

4.9.4