com.gemalto.idp.mobile.core

Class IdpCore

java.lang.Object

com.gemalto.idp.mobile.core.IdpCore

public abstract class IdpCore
extends Object

IdpCore is the entry-point of the SDK Core. IdpCore takes the configurations needed for different modules and provides shared SDK functionalities.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
IdpCore()

Method Summary

Modifier and Type	Method and Description
static IdpCore	configure(boolean deviceSourceBinding, byte[] activationCode, IdpConfiguration... config) Configure IdpCore.
static IdpCore	configure(boolean deviceSourceBinding, IdpConfiguration... config) Configure IdpCore.
static IdpCore	configure(byte[] activationCode, IdpConfiguration... config) Configure IdpCore.
static IdpCore	configure(IdpConfiguration... config) Configure IdpCore.
static IdpCore	getInstance() Get IdpCore instance.
abstract PasswordManager	getPasswordManager() Get passwordManager.
abstract RootDetector	getRootDetector() Get root detector which checks root status of the device.
abstract SecureContainerFactory	getSecureContainerFactory() Get factory object for creating SecureContainer objects.
static String	getVersion() Get version of IdpCore.
static boolean	isConfigured() Check if Core has been configured.
static boolean	isDeviceBinding() Check if DEVICE enabled or disabled.
static void	preLoad() Deprecated. This method will be removed in future major release, and has no effect calling it since 5.0.
static void	reset() Reset the core instance so that Core can be configured again with different settings.
static void	updateConfigurations(IdpConfiguration... configs) Update Configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdpCore

public IdpCore()

Method Detail

preLoad

public static void preLoad()

Deprecated. This method will be removed in future major release, and has no effect calling it since 5.0.

Preload native libraries, for security consideration, Ezio SDK will enforce the security related native libraries to be loaded before any other call into the SDK. This API call is optional. If this API is not invoked separately, the native libraries will be loaded synchrounously in IdpCore.configure(...) which would take add 100ms to 500ms to the IdpCore.configure(...) call depending on the device specification. It is recommended invoke the preLoad() in your application entry point:

• Application class onCreate()
• onCreate of The first Activity that is to be launched.

System.setProperty("java.io.tmpdir", getDir("files", Context.MODE_PRIVATE).getPath()); IdpCore.preLoad(); First option is preferred as it is invoked before any Activity/Service is started.

Since:

4.4

configure

public static IdpCore configure(IdpConfiguration... config)

Configure IdpCore. Must be called before using any other modules. Configuration can only be called once.

Parameters:

config - required for using OobModule & OtpModule

Returns:

IdpCore

Since:

4.0

configure

public static IdpCore configure(boolean deviceSourceBinding,
                                IdpConfiguration... config)

Configure IdpCore. Must be called before using any other modules. Configuration can only be called once.

Parameters:

deviceSourceBinding - device binding to enable or disable DEVICE fingerprint source. Enabling this flag is equivalent to including 'DEVICE' in the Device Fingerprint Source configuration in 2.X.

config - required for using OobModule & OtpModule

Returns:

IdpCore

Since:

4.4

configure

public static IdpCore configure(byte[] activationCode,
                                IdpConfiguration... config)

Configure IdpCore. Must be called before using any other modules. Configuration can only be called once.

Parameters:

activationCode - activation code to activate specific features. To be requested from Gemalto.

config - required for using OobModule & OtpModule

Returns:

IdpCore

Since:

4.0

configure

public static IdpCore configure(boolean deviceSourceBinding,
                                byte[] activationCode,
                                IdpConfiguration... config)

Configure IdpCore. Must be called before using any other modules. Configuration can only be called once.

Parameters:

deviceSourceBinding - device binding to enable or disable DEVICE fingerprint source. Enabling this flag is equivalent to including 'DEVICE' in the Device Fingerprint Source configuration in 2.X.

activationCode - activation code to activate specific features. To be requested from Gemalto.

config - required for using OobModule & OtpModule

Returns:

IdpCore

Since:

4.4

getInstance

public static IdpCore getInstance()

Get IdpCore instance. Throws IllegalStateException if not configured.

Returns:

IdpCore instance.

Since:

4.0

isConfigured

public static boolean isConfigured()

Check if Core has been configured.

Returns:

if IdpCore has been configured.

Since:

4.0

isDeviceBinding

public static boolean isDeviceBinding()

Check if DEVICE enabled or disabled.

Returns:

DEVICE enabled or disabled.

Since:

4.4

getVersion

public static String getVersion()

Get version of IdpCore.

Returns:

version.

Since:

4.0

getRootDetector

public abstract RootDetector getRootDetector()

Get root detector which checks root status of the device.

Returns:

RootDetector

Since:

4.0

getPasswordManager

public abstract PasswordManager getPasswordManager()

Get passwordManager. which is used to unlock secrets used by different modules.

Returns:

PasswordManager

Since:

4.0

getSecureContainerFactory

public abstract SecureContainerFactory getSecureContainerFactory()

Get factory object for creating SecureContainer objects.

Returns:

SecureContainerFactory

Since:

4.0

reset

public static void reset()

Reset the core instance so that Core can be configured again with different settings.

Since:

4.9.0

updateConfigurations

public static void updateConfigurations(IdpConfiguration... configs)

Update Configuration. This will replace existing one (if any) and add new one (if it does not exist previously). However, it will not delete existing one if configs parameter does not contains some of existing one

Parameters:

configs - list of configuration parameters. It does not need to contains all existing configurations

Since:

5.3.0