com.gemalto.idp.mobile.otp.provisioning

Class DskppConfigurationBuilder

java.lang.Object

com.gemalto.idp.mobile.otp.provisioning.DskppConfigurationBuilder

public class DskppConfigurationBuilder
extends Object

Builder of configuration for the token provisioning with the SPA server.

Since:

4.1

Constructor Summary

Constructors

Constructor and Description
DskppConfigurationBuilder(SecureString base64String, DskppProvisioningProtocol provisioningProtocolVersion, DskppProvisioningCallback dskppCallback, android.os.Handler dskppCallbackHandler, boolean wipePinBase64String) Initialize builder with mandatory configurations.
DskppConfigurationBuilder(URL serverUrl, SecureString userId, SecureString enrollmentPassword, DskppProvisioningProtocol provisioningProtocolVersion, DskppProvisioningCallback dskppCallback, android.os.Handler dskppCallbackHandler, boolean wipeUserIdPassword) Initialize builder with mandatory configurations.

Method Summary

Modifier and Type	Method and Description
ProvisioningConfiguration	build() Build DskppConfiguration object.
void	cancel() To be used when the building is for any reason cancelled before calling the build() method.
DskppConfigurationBuilder	setApplicationName(SecureString appName) Set the application name.
DskppConfigurationBuilder	setApplicationVersion(SecureString appVersion) Set the application version.
DskppConfigurationBuilder	setCapability(SecureString capability) Set capability.
DskppConfigurationBuilder	setDeviceFormFactor(SecureString deviceFormFactor) Set device form factor.
DskppConfigurationBuilder	setDeviceFriendlyName(SecureString name) Set device friendly name.
DskppConfigurationBuilder	setListToReceive(List<SecureString> listToReceive) Set list of tags for parsing DSKPP message and return by responseCallback ex: "mpdskpp:OOBSExtensionType","mpdskpp:PushExtensionType".
DskppConfigurationBuilder	setListToSend(List<android.util.Pair<String,SecureString>> listToSend) List of tags for sending to a server as DSKPP message <"mpdskpp:AppName","MobilePASS NG">.
DskppConfigurationBuilder	setParametersVersion(SecureString version) Set the parameter version of DSKPP provisioning.
DskppConfigurationBuilder	setPushCapable(boolean pushCapable) Set if push is capable.
DskppConfigurationBuilder	setRootStatus(boolean rooted) Set the root status of the device.
DskppConfigurationBuilder	setSecurityLevel(SecureString level) Set the security level.
DskppConfigurationBuilder	setTlsConfiguration(DskppTlsConfiguration tlsConfig) Set TLS configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

DskppConfigurationBuilder

public DskppConfigurationBuilder(URL serverUrl,
                                 SecureString userId,
                                 SecureString enrollmentPassword,
                                 DskppProvisioningProtocol provisioningProtocolVersion,
                                 DskppProvisioningCallback dskppCallback,
                                 android.os.Handler dskppCallbackHandler,
                                 boolean wipeUserIdPassword)

Initialize builder with mandatory configurations.

Parameters:

serverUrl - The address of the server to be used for the provisioning. Never null.

userId - The ID of the user for which the token shall be provisioned. Never null.

enrollmentPassword - The password of the enrollment process. Never null.

provisioningProtocolVersion - The version of the provisioning protocol to use (this depends on the DSKPP version used). Never null.

dskppCallback - The object of callback called when the SDK wants to inform the client application. Never null.

dskppCallbackHandler - The handler defining which thread the callbacks shall be redirected onto. If null then the callbacks will be called directly by the background thread handling the ongoing operation (from which the callback is triggered).

wipeUserIdPassword - Pass true to wipe the userId and enrollmentPassword values after these are taken.

Since:

4.1

DskppConfigurationBuilder

public DskppConfigurationBuilder(SecureString base64String,
                                 DskppProvisioningProtocol provisioningProtocolVersion,
                                 DskppProvisioningCallback dskppCallback,
                                 android.os.Handler dskppCallbackHandler,
                                 boolean wipePinBase64String)

Initialize builder with mandatory configurations.

Parameters:

base64String - The base 64 encoded data containing the server URL, the user ID and the enrollment password. Never null.

provisioningProtocolVersion - The version of the provisioning protocol to use (this depends on the DSKPP version used). Never null.

dskppCallback - The object of callback called when the SDK wants to inform the client application. Never null.

dskppCallbackHandler - The handler defining which thread the callbacks shall be redirected onto. If null then the callbacks will be called directly by the background thread handling the ongoing operation (from which the callback is triggered).

wipePinBase64String - Pass true to wipe the base64String values after this is taken.

Since:

4.1

Method Detail

setListToSend

public DskppConfigurationBuilder setListToSend(List<android.util.Pair<String,SecureString>> listToSend)

List of tags for sending to a server as DSKPP message <"mpdskpp:AppName","MobilePASS NG">.

This is an optional feature which allows the application to pass the custom data to the server during the provisioning process.

Parameters:

listToSend - The list of tags to use. Never null.

Returns:

The self reference to allow the builder pattern like call chaining. Never null.

Since:

4.1

setListToReceive

public DskppConfigurationBuilder setListToReceive(List<SecureString> listToReceive)

Set list of tags for parsing DSKPP message and return by responseCallback ex: "mpdskpp:OOBSExtensionType","mpdskpp:PushExtensionType".

This is an optional feature which allows the application to retrieve the custom data from the server during the provisioning process.

Parameters:

listToReceive - The list of custom data tags to retrieve from the server response. Never null.

Returns:

The self reference to allow the builder pattern like call chaining. Never null.

Since:

4.1

setTlsConfiguration

public DskppConfigurationBuilder setTlsConfiguration(DskppTlsConfiguration tlsConfig)

Set TLS configuration.

Parameters:

tlsConfig - TlsConfiguration

Returns:

builder

Since:

4.1

setApplicationName

public DskppConfigurationBuilder setApplicationName(SecureString appName)

Set the application name.

Parameters:

appName - application name

Returns:

builder

Since:

4.1

setApplicationVersion

public DskppConfigurationBuilder setApplicationVersion(SecureString appVersion)

Set the application version.

Parameters:

appVersion - application version

Returns:

builder

Since:

4.1

setRootStatus

public DskppConfigurationBuilder setRootStatus(boolean rooted)

Set the root status of the device. default value is 'false'.

Parameters:

rooted - if the device is rooted

Returns:

builder

Since:

4.1

setParametersVersion

public DskppConfigurationBuilder setParametersVersion(SecureString version)

Set the parameter version of DSKPP provisioning. default '1'.

Parameters:

version - the version

Returns:

builder

Since:

4.1

setCapability

public DskppConfigurationBuilder setCapability(SecureString capability)

Set capability. default '6'.

Parameters:

capability -

Returns:

builder

Since:

4.1

setSecurityLevel

public DskppConfigurationBuilder setSecurityLevel(SecureString level)

Set the security level. eg: "Soft" or "UICC". default to "Soft".

Parameters:

level - the security level.

Returns:

builder

Since:

4.1

setDeviceFriendlyName

public DskppConfigurationBuilder setDeviceFriendlyName(SecureString name)

Set device friendly name. The name will be stored on the back-end server. default "Android Device".

Parameters:

name - device name defined by the application.

Returns:

builder

Since:

4.1

setDeviceFormFactor

public DskppConfigurationBuilder setDeviceFormFactor(SecureString deviceFormFactor)

Set device form factor. default "Android".

Parameters:

deviceFormFactor -

Returns:

builder

setPushCapable

public DskppConfigurationBuilder setPushCapable(boolean pushCapable)

Set if push is capable. default 'false'.

Parameters:

pushCapable -

Returns:

builder

Since:

4.1

build

public ProvisioningConfiguration build()

Build DskppConfiguration object.

Returns:

ProvisioningConfiguration implementation.

Since:

4.1

cancel

public void cancel()

To be used when the building is for any reason cancelled before calling the build() method.

It performs the cleanup of the sensitive resources.

Since:

4.1